refactoring of jbake configuration #341

ancho · 2017-02-09T08:33:47Z

I started to refactor the configuration of jbake and it's components. See #340.

In general it's finished. But I want to write some more tests and add some logging in case options could not be found and things like that.

There are only two classes left with a direct dependency to a CompositeConfiguration, which are configuration specific classes.

Please take your time to review the changes. I hope you like it.

coveralls · 2017-02-09T08:36:35Z

Coverage increased (+9.8%) to 82.718% when pulling f0db5bd on ancho:feature/configuration-refactoring into 0f7b6c6 on jbake-org:master.

coveralls · 2017-02-12T10:44:56Z

Coverage increased (+10.08%) to 82.995% when pulling 45199f9 on ancho:feature/configuration-refactoring into 0f7b6c6 on jbake-org:master.

ancho · 2017-02-12T10:46:48Z

Ok. I think I'm finished.

ancho · 2017-03-11T10:37:52Z

Hello? Anybody out there? :)

jonbullock · 2017-03-13T23:19:56Z

Still here.... just busy preparing for a talk at the moment :)

ancho · 2017-03-14T17:03:31Z

All right. Just a ping. Worked obviously :)
Good luck with the talk then.

jonbullock · 2017-04-16T12:58:40Z

I haven't forgotten about this, I'll try and catch you on IRC to discuss what order is best to merge this and the other major PR's (such as the switch to Gradle).

coveralls · 2017-05-24T07:25:46Z

Coverage increased (+1.1%) to 81.211% when pulling 2486ab3 on ancho:feature/configuration-refactoring into 5a368e8 on jbake-org:master.

ancho · 2017-05-24T07:32:13Z

Hmm...I'm rebasing from time to time and I ask my self if it would find a way earlier into master if I add deprecated versions of the old Method/Constructor signatures that changed during the refactoring?

jonbullock · 2017-05-30T12:18:51Z

Thanks for rebasing this and keeping it up to date with master 👍

I've scheduled in a 2.7.0 release now so if you can add those deprecated methods/constructors for the build plugins (anything else as well?) I don't see why we can't include this in that release. What do you think?

ancho · 2017-05-31T21:17:26Z

I'll try to keep it up to date. It would be nice to see this as soon as possible. But I'm not sure if it's possible to get a 100% compatible version. The FileUtil lost the public static findExtension for example. But it doesn't make sense to add this method there. It's the wrong place and is part of the DefaultJBakeConfiguration now.

I'll open a new branch for this experiment and concentrate on the main classes like

Crawler
Parser
Asset
Oven
ContentStore
Renderer
implementations of MarkupEngine
implementations of RenderingTool
etc.

I touched 69 files. Ok...I can substract the tests but that will take some time.
The question is what classes are API classes and which modifications count as a normal refactoring changes that don't violate semantic versioning.

ancho · 2017-06-05T14:48:07Z

Ok. I created a new branch with restored methods and constructors.

I tested the snapshot version against the gradle plugin and my website project and it still works.

The CI failed a few times before, because the singleton ModelExtractors had registered engines from previous tests. So I had to implement a reset method to keep the tests clean and seperated from each other.
The same applies for DocumentTypes which already had a reset method.

I'm not quite sure if this is a problem for production too...

jonbullock · 2017-06-06T22:33:37Z

I can test the branch against the Maven plugin as I've just published v0.2.0 if you want to see if there is any major problems? If not we can schedule it in for 2.7.0.

ancho · 2017-06-06T22:42:04Z

That would be great. I will try to implement a test to verify we do not get problems with the singletons running bake in a loop removing document types. The only scenario I can think of at the moment.

ancho · 2018-03-10T10:18:04Z

Rebased to master and squashed to make a review easier.

manikmagar · 2018-03-11T20:11:50Z

jbake-core/src/main/java/org/jbake/app/configuration/ConfigUtil.java

+
+    private void displayLegacyConfigFileWarningIfRequired() {
+        LOGGER.warn("You have defined a part of your JBake configuration in {}", LEGACY_CONFIG_FILE);
+        LOGGER.warn("Usage of this file is being deprecated, please rename this file to: {} to remove this warning", CONFIG_FILE);


Should we say that Usage of this file is deprecated and will be removed in JBake 3.0. Please rename this file to {}?

manikmagar · 2018-03-11T20:18:07Z

jbake-core/src/main/java/org/jbake/parser/AsciidoctorEngine.java

+                    Date date = df.parse((String) value);
+                    contents.put("date", date);
+                } catch (ParseException e) {
+                    LOGGER.error("Unable to parse revdate. Expected {}", dateFormat, e);
                }
            }
            if (key.equals("jbake-tags")) {


Should we extract "jbake-tags" to a constant?

Yes. There is a lot of stuff we should put into constants or find better substitutes.
I just wanted to focus on the configuration part with this PR.

determine current sourcepath with user.dir system property

jonbullock · 2018-08-09T22:11:15Z

Shall we merge this before we merge smaller PR's like #471 ?

ancho · 2018-08-10T11:36:45Z

Makes sense. That way we "just" need to adjust the outstanding PR's.

jonbullock · 2018-08-12T17:45:33Z

Do you want to do the honours for this one?

ancho · 2018-08-13T12:36:03Z

My pleasure! Do you need to prepare something before? Should I wait or just merge it right now?

jonbullock · 2018-08-13T14:56:55Z

No I'm OK, go for it.

…

On Mon, 13 Aug 2018, 1:36 pm Frank Becker, ***@***.***> wrote: My pleasure! Do you need to prepare something before? Should I wait or just merge it right now? — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#341 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABOcf8L6sZzmRvAaeVm0wVRhy6ARCU4zks5uQXK0gaJpZM4L714a> .

a fragment of an not properly removed file during refactoring jbake-org#341 closes jbake-org#608

ancho changed the title ~~[WIP] refactoring of jbake configuration~~ refactoring of jbake configuration Feb 12, 2017

jonbullock added the enhancement label Apr 16, 2017

jonbullock added this to the v3.0.0 milestone Apr 17, 2017

jonbullock mentioned this pull request Apr 18, 2017

Hide CompositeConfiguration #73

Closed

ancho force-pushed the feature/configuration-refactoring branch from 45199f9 to a788ee1 Compare May 9, 2017 17:38

ancho mentioned this pull request May 22, 2017

Github based Theme Release System #370

Open

ancho force-pushed the feature/configuration-refactoring branch from a788ee1 to 3d55f33 Compare May 24, 2017 07:21

ancho force-pushed the feature/configuration-refactoring branch from 3d55f33 to 2e2b580 Compare March 10, 2018 09:56

ancho modified the milestones: v3.0.0, v2.7.0 Mar 10, 2018

ancho force-pushed the feature/configuration-refactoring branch from 2e2b580 to 55ac964 Compare March 10, 2018 10:33

manikmagar reviewed Mar 11, 2018

View reviewed changes

ancho force-pushed the feature/configuration-refactoring branch from 189cbc3 to 301af6a Compare April 9, 2018 08:51

ancho added 11 commits August 4, 2018 11:01

jdk9 and orientdb needs a lot more MaxDirectMemorySize

ece3333

restored Crawler buildURI functionality

8d734c4

fixed tests for windows and mac environments

eef0e19

determine current sourcepath with user.dir system property

code cleanup. extract properties to JBakeProperty class

b013d2c

more code cleanup

9a0727a

optimized imports

0e8f13b

further cleanup

982ad12

cleanup MarkupEngine

448fd44

cleanup

0435b6b

fix test fixture acces in ContentStoreIntegrationTest

1803027

fix codacy issues

2486ab3

ancho force-pushed the feature/configuration-refactoring branch from 931d902 to 2486ab3 Compare August 4, 2018 09:02

jonbullock modified the milestones: v2.7.0, v2.6.2 Aug 12, 2018

jonbullock assigned ancho Aug 12, 2018

ancho merged commit 4f3a18a into jbake-org:master Aug 14, 2018

ancho mentioned this pull request Aug 14, 2018

Introduce a configuration abstraction to access configuration properties in a clean and concise way #340

Closed

ancho mentioned this pull request Jun 19, 2019

Inconsistencies in deployed artifacts on maven central #607

Closed

ancho added a commit to ancho/jbake that referenced this pull request Mar 29, 2020

remove empty ConfigUtil

9a200ce

a fragment of an not properly removed file during refactoring jbake-org#341 closes jbake-org#608

ancho mentioned this pull request Mar 29, 2020

remove empty ConfigUtil #625

Merged

ancho deleted the feature/configuration-refactoring branch May 1, 2020 14:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactoring of jbake configuration #341

refactoring of jbake configuration #341

ancho commented Feb 9, 2017

coveralls commented Feb 9, 2017

coveralls commented Feb 12, 2017 •

edited

Loading

ancho commented Feb 12, 2017

ancho commented Mar 11, 2017

jonbullock commented Mar 13, 2017

ancho commented Mar 14, 2017

jonbullock commented Apr 16, 2017

coveralls commented May 24, 2017 •

edited

Loading

ancho commented May 24, 2017

jonbullock commented May 30, 2017

ancho commented May 31, 2017

ancho commented Jun 5, 2017 •

edited

Loading

jonbullock commented Jun 6, 2017

ancho commented Jun 6, 2017

ancho commented Mar 10, 2018

manikmagar Mar 11, 2018

manikmagar Mar 11, 2018

ancho Mar 11, 2018

jonbullock commented Aug 9, 2018

ancho commented Aug 10, 2018

jonbullock commented Aug 12, 2018

ancho commented Aug 13, 2018

jonbullock commented Aug 13, 2018 via email

refactoring of jbake configuration #341

refactoring of jbake configuration #341

Conversation

ancho commented Feb 9, 2017

coveralls commented Feb 9, 2017

coveralls commented Feb 12, 2017 • edited Loading

ancho commented Feb 12, 2017

ancho commented Mar 11, 2017

jonbullock commented Mar 13, 2017

ancho commented Mar 14, 2017

jonbullock commented Apr 16, 2017

coveralls commented May 24, 2017 • edited Loading

ancho commented May 24, 2017

jonbullock commented May 30, 2017

ancho commented May 31, 2017

ancho commented Jun 5, 2017 • edited Loading

jonbullock commented Jun 6, 2017

ancho commented Jun 6, 2017

ancho commented Mar 10, 2018

manikmagar Mar 11, 2018

Choose a reason for hiding this comment

manikmagar Mar 11, 2018

Choose a reason for hiding this comment

ancho Mar 11, 2018

Choose a reason for hiding this comment

jonbullock commented Aug 9, 2018

ancho commented Aug 10, 2018

jonbullock commented Aug 12, 2018

ancho commented Aug 13, 2018

jonbullock commented Aug 13, 2018 via email

coveralls commented Feb 12, 2017 •

edited

Loading

coveralls commented May 24, 2017 •

edited

Loading

ancho commented Jun 5, 2017 •

edited

Loading