review-retrovert 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 978ce194146ec4de6a7ece5ac4ba182e6eff60670836f952f22578a25ec10a9e
-  data.tar.gz: 6889acc0183d72d30b7f87fdbd0fc4e5bd986b350d4c7fae8ba8e5895e7a476b
+  metadata.gz: d88019dcbdef1f19522028bd668913c7f2100d2774796ca208a7e72df829b3ef
+  data.tar.gz: 4b3605223424275e592269e6fbfd1124275087c322522b0d5cb309434ee202ac
 SHA512:
-  metadata.gz: 2246191d2e227e1c8a4d322a9d9ec4f84e85904285e4952cabc6df9a87f89f1eab761edda301aca5e950494aa341e8e9ebeb4675118450082d841eea909c982e
-  data.tar.gz: c8f3757ef2da91d51c5fed0954e5ef4c710bbaee3fe014e728ae16d5f3a47bc10861910dc2d121a085e8ba14a7380ccf02e664f81ee64c582b6ba3b21e750078
+  metadata.gz: 519813a8c9690db53484fb206084a97c36c8bfe1c230fe09bb623c7d93ce178a81b1bb91eed87a9edfb1c753b345e0d12ca36f50bf8789ea0a6906126b62e771
+  data.tar.gz: '02823e04d7787079bcf94273ab43af37d903c8d8de357fde7c8394094ff88a5e2275e173284496eccf328f74da11c11b8b3d2233814529cb00b4021ff014b19d'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    review-retrovert (0.9.3)
-      review (>= 3.2.0)
+    review-retrovert (0.9.4)
+      review (>= 3.0.0)
       thor
 
 GEM

data/README.md

@@ -4,7 +4,7 @@
 
 # ReVIEW::Retrovert
 
-[Re:VIEW Starter](https://kauplan.org/reviewstarter/) Project convert to [Re:VIEW](https://reviewml.org/ja/) 3.X
+[Re:VIEW Starter](https://kauplan.org/reviewstarter/) Project convert to [Re:VIEW](https://reviewml.org/ja/) 3.X/4.X/5.X
 
 ## Installation
 
@@ -22,12 +22,69 @@ Or install it yourself as:
 
     $ gem install review-retrovert
 
-## Usage
+## Commands
+
+```sh
+Commands:
+  review-retrovert convert {review_starter_configfile} {outdir}  # convert Re:VIEW Starter project to Re:VIEW project
+  review-retrovert help [COMMAND]                                # Describe available commands or one specific command
+  review-retrovert version                                       # show version
+```
+
+### Convert
+
+e.g.
 
 ```sh
 review-retrovert convert /path/to/dir/review-starter/config.yml <output directory>
 ```
 
+Options
+
+```sh
+Usage:
+  review-retrovert convert {review_starter_configfile} {outdir}
+
+Options:
+  f, [--force]                                     # Force output
+      [--strict], [--no-strict]                    # Only process files registered in the catalog
+      [--preproc], [--no-preproc]                  # Execute preproc after conversion
+      [--tabwidth=N]                               # Preproc tabwidth option value
+                                                   # Default: 0
+      [--table-br-replace=TABLE-BR-REPLACE]        # @<br>{} in table replace string (Default: empty)
+      [--table-empty-replace=TABLE-EMPTY-REPLACE]  # empty cell(.) in table replace string (Default full-width space)
+                                                   # Default: 　
+
+convert Re:VIEW Starter project to Re:VIEW project
+```
+
+#### retrovert config
+
+If the retrovert key is present in config.yml, the subordinate elements will take effect after convert.
+
+If you have a setting that you want to enable only after retrovert, use inherit as shown below.
+
+* config-retrovert.yml
+
+```yml
+retrovert:
+  chapterlink: null
+```
+
+* config-base.yml
+
+```yml
+chapterlink: true
+```
+
+* config.yml
+
+```yml
+inherit: ["config-base.yml", "config-starter.yml", "config-retrovert.yml"]
+
+#chapterlink: true
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -40,7 +97,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/srz-zu
 
 ## Develop
 
-docker run -it --rm -v $(pwd)/:/work -w /work vvakame/review:3.2 bash
+docker run -it --rm -v $(pwd)/:/work -w /work vvakame/review:5.0 bash
 
 ## License
 

data/lib/review/retrovert/cli.rb

@@ -9,8 +9,8 @@ module ReVIEW
       method_option "strict", desc: 'Only process files registered in the catalog', type: :boolean
       method_option "preproc", desc: 'Execute preproc after conversion', type: :boolean
       method_option "tabwidth", desc: 'Preproc tabwidth option value', type: :numeric, default: 0
-      method_option "table-br-replace", desc: '@<br>{} in table replace string', type: :string, default: ''
-      method_option "table-empty-replace", desc: 'empty cell(.) in table replace string', type: :string, default: '　'
+      method_option "table-br-replace", desc: '@<br>{} in table replace string (Default: empty)', type: :string, default: ''
+      method_option "table-empty-replace", desc: 'empty cell(.) in table replace string (Default full-width space)', type: :string, default: '　'
       def convert(review_starter_configfile, outdir)
         Converter.execute(review_starter_configfile, outdir, options)
       end

data/lib/review/retrovert/converter.rb

@@ -13,6 +13,8 @@ module ReVIEW
         @outimagedir = nil
         @logger = ReVIEW.logger
         @configs = YamlConfig.new
+        @embeded_contents = []
+        @catalog_contents = []
       end
 
       def error(msg)
@@ -67,9 +69,14 @@ module ReVIEW
         @configs.rewrite_yml('contentdir', '.')
         @configs.rewrite_yml('hook_beforetexcompile', 'null')
         @configs.rewrite_yml('texstyle', '["reviewmacro"]')
-        @configs.rewrite_yml('chapterlink', 'null')
+        # @configs.rewrite_yml('chapterlink', 'null')
         pagesize = @config['starter']['pagesize'].downcase
         @configs.rewrite_yml_array('texdocumentclass', "[\"review-jsbook\", \"media=print,paper=#{pagesize}\"]")
+        @config['retrovert'].each{ |k,v|
+          unless v..is_a?(Hash)
+            @configs.commentout_root_yml(k)
+          end
+        }
       end
 
       def replace_compatible_block_command_outline(content, command, new_command, option_count)
@@ -294,6 +301,7 @@ module ReVIEW
             outpath = File.join(File.absolute_path(outdir), filepath)
             FileUtils.mkdir_p(File.dirname(outpath))
             FileUtils.cp(srcpath, outpath)
+            @embeded_contents.push(filepath[0])
             update_content(outpath, outpath)
           end
         end
@@ -420,8 +428,13 @@ module ReVIEW
         files = contentfiles.is_a?(String) ? contentfiles.split(/\R/) : contentfiles
         files.each do |content|
           contentpath = File.join(contentdir, content)
+          srccontentpath = File.join(@srccontentsdir, content)
+          if @embeded_contents.include?(srccontentpath)
+            info "skip copy maped file #{contentpath}"
+            next
+          end
           unless File.exist?(contentpath)
-            srcpath = File.join(File.join(@basedir, @srccontentsdir), content)
+            srcpath = File.join(@basedir, srccontentpath)
             # info srcpath
             if File.exist?(srcpath)
               FileUtils.cp(srcpath, contentdir)
@@ -437,15 +450,11 @@ module ReVIEW
         contentdir = abspath
         info 'replace starter block command'
         info 'replace starter inline command'
-        if options['strict']
-          catalog = ReVIEW::Catalog.new(File.open(File.join(abspath, yamlfile)))
-          update_content_files(outdir, contentdir, catalog.predef())
-          update_content_files(outdir, contentdir, catalog.chaps())
-          update_content_files(outdir, contentdir, catalog.appendix())
-          update_content_files(outdir, contentdir, catalog.postdef())
-        else
-          # copy_contents(outdir)
-          contentsfiles = Pathname.glob(File.join(File.join(@basedir, @srccontentsdir), '*.re')).map(&:basename)
+        catalog = ReVIEW::Catalog.new(File.open(File.join(abspath, yamlfile)))
+        update_content_files(outdir, contentdir, @catalog_contents)
+        unless options['strict']
+          all_contentsfiles = Pathname.glob(File.join(File.join(@basedir, @srccontentsdir), '*.re')).map(&:basename)
+          contentsfiles = all_contentsfiles.select{ |path| ! @catalog_contents.include?(path.to_s) }
           update_content_files(outdir, contentdir, contentsfiles)
         end
       end
@@ -463,6 +472,7 @@ module ReVIEW
             Dir.chdir(pwd)
             content = buf.string
             content.gsub!(/^#[@]map.*$/, '')
+            content.gsub!(/^#[@]end$/, '')
             File.write(contentpath, content)
           end
         end
@@ -478,12 +488,8 @@ module ReVIEW
 
         if options['strict']
           catalog = ReVIEW::Catalog.new(File.open(File.join(abspath, yamlfile)))
-          preproc_content_files(outdir, pp, contentdir, catalog.predef())
-          preproc_content_files(outdir, pp, contentdir, catalog.chaps())
-          preproc_content_files(outdir, pp, contentdir, catalog.appendix())
-          preproc_content_files(outdir, pp, contentdir, catalog.postdef())
+          preproc_content_files(outdir, pp, contentdir, @catalog_contents)
         else
-          # copy_contents(outdir)
           contentsfiles = Pathname.glob(File.join(File.join(@basedir, @srccontentsdir), '*.re')).map(&:basename)
           preproc_content_files(outdir, pp, contentdir, contentsfiles)
         end
@@ -496,11 +502,22 @@ module ReVIEW
         FileUtils.rm(Dir.glob(File.join(outdir, '*.re')))
       end
 
+      def add_catalog_contents(contentfiles)
+        files = contentfiles.is_a?(String) ? contentfiles.split(/\R/) : contentfiles
+        @catalog_contents.concat(files)
+      end
+
       def load_config(yamlfile)
         @configs.open(yamlfile)
         @config = @configs.config
         @basedir = @configs.basedir
         @srccontentsdir = @config['contentdir']
+
+        catalog = ReVIEW::Catalog.new(File.open(@configs.catalogfile()))
+        add_catalog_contents(catalog.predef())
+        add_catalog_contents(catalog.chaps())
+        add_catalog_contents(catalog.appendix())
+        add_catalog_contents(catalog.postdef())
       end
 
       def create_initial_project(outdir, options)

data/lib/review/retrovert/version.rb

@@ -1,5 +1,5 @@
 module ReVIEW
   module Retrovert
-    VERSION = "0.9.3"
+    VERSION = "0.9.4"
   end
 end

data/lib/review/retrovert/yamlconfig.rb

@@ -87,9 +87,19 @@ module ReVIEW
         rewrite_retrovert_yml()
       end
 
+      def commentout(yamlfile, key)
+        content = File.read(yamlfile)
+        content.gsub!(/^(\s*)#{key}:(.*)$/, "#\\1#{key}:\\2")
+        File.write(yamlfile, content)
+      end
+
+      def commentout_root_yml(key)
+        commentout(File.join(@basedir, @basename), key)
+      end
+
       def rewrite_yml_(yamlfile, key, val)
         content = File.read(yamlfile)
-        content.gsub!(/^(\s*)#{key}:.*$/, '\1' + "#{key}: #{val}")
+        content.gsub!(/^(\s*)#{key}:.*$/, "\\1#{key}: #{val}")
         File.write(yamlfile, content)
       end
 
@@ -121,6 +131,7 @@ module ReVIEW
           # YAML.dump(yaml, File.open(yamlfile, "w"))
           content = Psych.dump(yaml)
           content.gsub!('---','')
+          content.gsub!(/^(.*):\s*$/, '\1: null')
           File.write(yamlfile, content)
         }
       end
@@ -137,6 +148,14 @@ module ReVIEW
         return yaml
       end
 
+      def path()
+        File.join(@basedir, @basename)
+      end
+
+      def catalogfile()
+        File.join(@basedir, @config['catalogfile'])
+      end
+
     end
   end
 end

data/review-retrovert.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor"
   spec.add_development_dependency "aruba"
-  spec.add_runtime_dependency "review", ['>= 3.2.0']
+  spec.add_runtime_dependency "review", ['>= 3.0.0']
 end

data/testdata/mybook/catalog.yml

@@ -8,6 +8,7 @@ CHAPS:
   - 04-customize.re
   - 05-faq.re
   - 06-bestpractice.re
+  - r0-root.re
 
 APPENDIX:
   - 91-compare.re

data/testdata/mybook/config-retrovert.yml

@@ -0,0 +1,7 @@
+# review-retrovert で変換したときに上書きする設定
+# 現在はトップレベルのコメントアウトのみ対応
+# サブ階層の設定を上書きしたい場合は、対象設定を inherit な yml ファイルに記述
+# > inherit: [config-base.yml, config-retrovert.yml]
+# 上記のようにすることで retrovert 後のプロジェクトでのみ設定を上書きできます
+retrovert:
+  chapterlink: null

data/testdata/mybook/config.yml

@@ -15,7 +15,7 @@ review_version: 2.0
 # その値がB.ymlよりも優先される。
 # 同様にA.yml、B.yml内でさらにinherit:パラメータを使うこともできる。
 # inherit: ["A.yml", "B.yml"]
-inherit: ["config-starter.yml"]
+inherit: ["config-starter.yml", "config-retrovert.yml"]
 
 # ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
 bookname: mybook

data/testdata/mybook/contents/r0-inner.re

@@ -0,0 +1,2 @@
+== Inner file
+

data/testdata/mybook/contents/r0-root.re

@@ -0,0 +1,4 @@
+= Retrovert テスト用
+
+#@mapfile(contents/r0-inner.re)
+#@end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: review-retrovert
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - srz_zumix
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.0.0
 description: Re:VIEW Starter to Re:VIEW
 email:
 - zumix.cpp@gmail.com
@@ -90,6 +90,7 @@ files:
 - testdata/mybook/README.md
 - testdata/mybook/Rakefile
 - testdata/mybook/catalog.yml
+- testdata/mybook/config-retrovert.yml
 - testdata/mybook/config-starter.yml
 - testdata/mybook/config.yml
 - testdata/mybook/contents/00-preface.re
@@ -103,6 +104,8 @@ files:
 - testdata/mybook/contents/92-filelist.re
 - testdata/mybook/contents/93-background.re
 - testdata/mybook/contents/99-postface.re
+- testdata/mybook/contents/r0-inner.re
+- testdata/mybook/contents/r0-root.re
 - testdata/mybook/css/normalize.css
 - testdata/mybook/css/webstyle.css
 - testdata/mybook/images/03-syntax/favicon-16x16.png