source2md 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d5d290b79e8ad279ee4bda3e6266211431849d716d50a5af30619c86bb4dd5
-  data.tar.gz: 90a98c2ce160304af7782b82bc48869a57fb6962ba77ade63d0f5a107dac19fd
+  metadata.gz: 804f40a21fe77faa747a631bd93fa6592d7bf035858fd4a8ba795f776dcb512b
+  data.tar.gz: 5f6d342b20388915027fa33c6d1d1a644ac5c28c56febd4e612ba318c14df375
 SHA512:
-  metadata.gz: 5719beeb1cbc4cfd30bf5e2620dc7f23a538f283011a3c801a1a9ce50ba5d9f8c1cd34c544528743192cfbf506ed500c95f416ac9703dcabb0251f0e0763ef39
-  data.tar.gz: 564b9a9582860c1fee3d7c6b8aac8a44a6bfffc5f898c2d4a1f634b2f23edf86523924a86df15a0d9e35e64f5f379cb27759ba2f98a90c1088cdf4a81899eab3
+  metadata.gz: 7dabbca4c2adf8136803fa1c1184975e1e41484620ac1350507fa196254202fcc3b5dde0f59fe31206472782274b4785048fad1b92e6ebee0873839b12b68a46
+  data.tar.gz: e46f3cf966becc687447b2394e9a02ba26ecd8d6ea2463049cfaf3a596f99bf5de3d5de2fbfede43db2ca2ca2c5fb206025731415ac78f5eeb93532193d03132

data/README.md

@@ -1,5 +1,13 @@
 # Source2MD: Markdown generator from source code
 
+## Install ##
+
+```
+$ gem i source2md
+```
+
+## Example ##
+
 input.rb:
 
 ```ruby

data/examples/element_deep_comment.rb

@@ -3,6 +3,20 @@ require "./setup"
 puts Source2MD::Element.new(<<~EOS).to_md
 ## foo
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementDeepComment
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> ## foo
+# >> 
+# >> out:
+# >> ```ruby
+# >> # foo
+# >> ```
+# >> --------------------------------------------------------------------------------
 # >> ```ruby
 # >> # foo
 # >> ```

data/examples/element_md_header.rb

@@ -5,6 +5,22 @@ puts Source2MD::Element.new(<<~EOS).to_md
 foo
 ---
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementMdHeader
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> ---
+# >> foo
+# >> ---
+# >> 
+# >> out:
+# >> ---
+# >> foo
+# >> ---
+# >> --------------------------------------------------------------------------------
 # >> ---
 # >> foo
 # >> ---

data/examples/element_method.rb

@@ -8,6 +8,30 @@ code1
 #
 code2
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementMethod
+# >> 
+# >> head:
+# >> {:name=>"(name)", :desc=>"(desc)", :comment=>"(comment)"}
+# >> 
+# >> in:
+# >> code1
+# >> #
+# >> code2
+# >> 
+# >> out:
+# >> ### (name)
+# >> 
+# >> (desc)
+# >> 
+# >> ```ruby
+# >> code1
+# >> 
+# >> code2
+# >> ```
+# >> 
+# >> (comment)
+# >> --------------------------------------------------------------------------------
 # >> ### (name)
 # >> 
 # >> (desc)

data/examples/element_pre.rb

@@ -3,6 +3,20 @@ require "./setup"
 puts Source2MD::Element.new(<<~EOS).to_md
 code
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementPre
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> code
+# >> 
+# >> out:
+# >> ```ruby
+# >> code
+# >> ```
+# >> --------------------------------------------------------------------------------
 # >> ```ruby
 # >> code
 # >> ```

data/examples/element_reject.rb

@@ -3,4 +3,15 @@ require "./setup"
 puts Source2MD::Element.new(<<~EOS).to_md
 require "setup"
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementReject
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> require "setup"
+# >> 
+# >> out:
+# >> --------------------------------------------------------------------------------
 # >> 

data/examples/element_table.rb

@@ -8,6 +8,26 @@ puts Source2MD::Element.new(<<~EOS).to_md
 # | x | x | x |
 # |---+---+---|
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementTable
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> # |---+---+---|
+# >> # | x | x | x |
+# >> # |---+---+---|
+# >> # | x | x | x |
+# >> # | x | x | x |
+# >> # |---+---+---|
+# >> 
+# >> out:
+# >> | x | x | x |
+# >> |---|---|---|
+# >> | x | x | x |
+# >> | x | x | x |
+# >> --------------------------------------------------------------------------------
 # >> | x | x | x |
 # >> |---|---|---|
 # >> | x | x | x |

data/examples/element_text.rb

@@ -4,5 +4,19 @@ puts Source2MD::Element.new(<<~EOS).to_md
 # - foo
 #   https://example.com/
 EOS
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementText
+# >> 
+# >> head:
+# >> {}
+# >> 
+# >> in:
+# >> # - foo
+# >> #   https://example.com/
+# >> 
+# >> out:
+# >> - foo
+# >>   https://example.com/
+# >> --------------------------------------------------------------------------------
 # >> - foo
 # >>   https://example.com/

data/examples/element_title2.rb

@@ -3,4 +3,18 @@ require "./setup"
 puts Source2MD::Element.new(<<~EOS).to_md
 # title2: (foo)
 EOS
-# >> ## (foo)
+# >> title2: (foo)
+# >> --------------------------------------------------------------------------------
+# >> Source2MD::Type::ElementTitle2
+# >> 
+# >> head:
+# >> {:title2=>"(foo)"}
+# >> 
+# >> in:
+# >> 
+# >> 
+# >> out:
+# >> ## (foo) ##
+# >> --------------------------------------------------------------------------------
+# >> title2: (foo)
+# >> ## (foo) ##

data/examples/output.md

@@ -1,4 +1,4 @@
-## (title)
+## (title) ##
 
 ### (name1)
 

data/examples/setup.rb

@@ -1,3 +1,3 @@
 $LOAD_PATH.unshift("#{__dir__}/../lib")
 require "source2md"
-Source2MD.quiet = true
+Source2MD.logger.level = :debug

data/lib/source2md/cli.rb

@@ -1,9 +1,18 @@
 module Source2MD
   class Cli < Thor
-    class_option :debug, type: :boolean
-    class_option :quiet, type: :boolean
+    class_option :debug, type: :boolean, aliases: "-d", default: false
 
-    desc "generate [files]", "生成"
+    def initialize(...)
+      super
+
+      if options[:debug]
+        Source2MD.logger.level = :debug
+        Source2MD.debug = true
+      end
+    end
+
+    map "g" => :generate
+    desc "generate [files]", "Markdown generation"
     option :output_file, type: :string, aliases: "-o", default: "output.md"
     def generate(*files)
       Generator.new(options.to_options.merge(files: files)).call

data/lib/source2md/logger.rb

@@ -0,0 +1,3 @@
+module Source2MD
+  mattr_accessor(:logger) { ActiveSupport::Logger.new(STDOUT, level: :info) }
+end

data/lib/source2md/tasks/about.rake

@@ -1,5 +1,5 @@
 desc "About"
 task :about do
   require "source2md"
-  tp Source2MD::VERSION
+  puts Source2MD::VERSION
 end

data/lib/source2md/type/base.rb

@@ -9,6 +9,23 @@ module Source2MD
 
       def initialize(element)
         @element = element
+
+        Source2MD.logger.debug do
+          o = []
+          o << "-" * 80
+          o << self.class.name
+          o << ""
+          o << "head:"
+          o << element.head
+          o << ""
+          o << "in:"
+          o << element.body
+          o << ""
+          o << "out:"
+          o << to_md
+          o << "-" * 80
+          o.compact * "\n"
+        end
       end
 
       def to_md

data/lib/source2md/type/element_title2.rb

@@ -6,10 +6,8 @@ module Source2MD
       end
 
       def to_md
-        unless Source2MD.quiet
-          p element.head[:title2]
-        end
-        "## #{element.head[:title2]}"
+        Source2MD.logger.info { "title2: #{element.head[:title2]}" }
+        "## #{element.head[:title2]} ##"
       end
     end
   end

data/lib/source2md/version.rb

@@ -1,3 +1,3 @@
 module Source2MD
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/source2md.rb

@@ -1,22 +1,27 @@
+require "active_support/logger"
+require "active_support/isolated_execution_state"
+
 require "active_support/core_ext/hash"
+require "active_support/core_ext/string"
+
 require "active_support/configurable"
-require "zeitwerk"
-require "table_format"
+
 require "pathname"
 require "thor"
 
 module Source2MD
   include ActiveSupport::Configurable
   config_accessor(:debug) { false }
-  config_accessor(:quiet) { false }
 end
 
+require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/source2md/logger.rb")
 loader.ignore("#{__dir__}/source2md/**/_*.rb")
-
 loader.inflector.inflect("source2md" => "Source2MD")
-
 loader.log! if false
 loader.setup
 
+require "source2md/logger"
+
 loader.eager_load if true

data/source2md.gemspec

@@ -18,14 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "test-unit"
-
   spec.add_dependency "zeitwerk"
   spec.add_dependency "activesupport"
   spec.add_dependency "pathname"
   spec.add_dependency "thor"
-  spec.add_dependency "table_format"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "test-unit"
 end

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ Pathname.glob("#{__dir__}/support/**/*.rb") { |e| require e.to_s }
 
 Zeitwerk::Loader.eager_load_all
 
-Source2MD.quiet = true
+Source2MD.logger.level = :error
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: source2md
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Akira Ikeda
@@ -11,27 +11,13 @@ cert_chain: []
 date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,13 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: pathname
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: zeitwerk
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,13 +81,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pathname
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,13 +95,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: table_format
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -144,7 +130,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - Gemfile
 - README.md
 - Rakefile
@@ -167,10 +152,10 @@ files:
 - lib/source2md/element.rb
 - lib/source2md/file_block.rb
 - lib/source2md/generator.rb
+- lib/source2md/logger.rb
 - lib/source2md/tasks/about.rake
 - lib/source2md/tasks/test.rake
 - lib/source2md/text_helper.rb
-- lib/source2md/type/__element_header_comment.rb
 - lib/source2md/type/base.rb
 - lib/source2md/type/element_deep_comment.rb
 - lib/source2md/type/element_md_header.rb

data/.rspec

@@ -1 +0,0 @@
---color

data/lib/source2md/type/__element_header_comment.rb

@@ -1,40 +0,0 @@
-#
-# #- foo
-# 1 + 2
-#
-# ↓
-#
-# foo
-#
-# ```ruby
-# 1 + 2
-# ```
-#
-module Source2MD
-  module Type
-    class ElementHeaderComment < Base
-      def self.accept?(element)
-        element.body.match?(/^#-/)
-      end
-
-      def to_md
-        [
-          message,
-          "```ruby",
-          body,
-          "```",
-        ] * "\n"
-      end
-
-      private
-
-      def message
-        element.body.scan(/^#-\s*(.*)/).join
-      end
-
-      def body
-        element.body.gsub(/^#-.*\R/, "")
-      end
-    end
-  end
-end