markdown_ruby_documentation 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ade506279b6b5d39ffa42bb4fc50b61d255222
-  data.tar.gz: c8426d9d8b851257d312552e13b6c84198b972b5
+  metadata.gz: e8c6f0e6b1c0fb7528b57ad280a000931265d2f2
+  data.tar.gz: 77ffedcd22721423e8467e5ffe01bb75fb80d4b7
 SHA512:
-  metadata.gz: 1473d3b33e26b1b26b818281d8d9c15112aa63840bad2c0e1b56de1413ddad1166c3f954acf2b41f1ab402d865c5bb6616943ad1609b1df69c2cfc0106b896ac
-  data.tar.gz: c41fc56eee17895ec7ee5f156ab3481b0ea6557aea8ddec81f55116fe67de990f099e684f2f1a5010f7b661c285a61b46a478e5b89a078c30dab190b71d2cc76
+  metadata.gz: 29f309277dc2b1bbcf9889b6163a38353de6fd891190c216e230b8224d7847247583971c813edbb33a270ca2b14d25f68564eecd1a6e123f7202618c4d377945
+  data.tar.gz: 06d6fdc408865c05d96b473468f933428c532d34153da397a6c9c68b3bf9b00d1be619c897a02850afa5a0badbb6de11fea16bda7263e0f7a7f7366b26c338d4

data/README.md

@@ -98,18 +98,18 @@ Converts case statements and if statements to bulleted markdown
    `example ruby_to_markdown(ruby_operators_to_english: { proc: ->(replacement, match) { "do some alteration" }})`
    
 **processors**
-* readable_ruby_numbers
-* pretty_early_return
-* convert_early_return_to_if_else
-* ternary_to_if_else
-* ruby_if_statement_to_md
-* ruby_case_statement_to_md
+* readable_ruby_numbers, options: proc(ruby_number_object, number_as_string)
+* pretty_early_return, options: proc(replacement, match)
+* convert_early_return_to_if_else, options: proc(replacement, match)
+* ternary_to_if_else, options: proc(replacement, match)
+* ruby_if_statement_to_md, options: proc(replacement, match)
+* ruby_case_statement_to_md, options: proc(replacement, match)
 * ruby_operators_to_english, options: proc(replacement, match)
 * methods_as_local_links, options: method_to_class: { method_name => OwningConstant }
-* question_mark_method_format
-* remove_end_keyword
-* constants_with_name_and_value
-* remove_memoized_vars
+* question_mark_method_format, options: proc(replacement, match)
+* remove_end_keyword, options: proc(replacement, match)
+* constants_with_name_and_value, options: proc(replacement, match, opt={})
+* remove_memoized_vars, options: proc(replacement, match)
 
 
 #### `format_link`

data/lib/markdown_ruby_documentation/template_parser.rb

@@ -142,39 +142,49 @@ module MarkdownRubyDocumentation
         ruby_source        = any_args.source_code
 
         RUBY_TO_MARKDOWN_PROCESSORS.each do |processor|
-          options     = disable_processors.fetch(processor, {})
-          ruby_source = send(processor, ruby_source, options) if options
+          options     = disable_processors.fetch(processor, :enabled)
+          ruby_source =  if options == :enabled
+            send(processor, ruby_source)
+          elsif options.is_a?(Hash)
+            send(processor, ruby_source, options)
+          end
         end
         ruby_source
       end
 
-      def comment_format(source_code, proc: false)
+      def comment_format(source_code=print_method_source, proc: false)
         gsub_replacement(source_code, { /^#(.*)/ => "</br>*(\\1)*</br>" }, proc: proc)
       end
 
-      def remove_memoized_vars(source_code=print_method_source, *)
-        source_code.gsub(/@[a-z][a-z0-9_]+ \|\|=?\s/, "") # @memoized_vars ||=
+      def remove_memoized_vars(source_code=print_method_source, proc: false)
+        conversions = {
+          /@[a-z][a-z0-9_]+ \|\|=?\s/ => "" # @memoized_vars ||=
+        }
+        gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def nil_check_readable(source_code, proc: false)
+      def nil_check_readable(source_code=print_method_source, proc: false)
         conversions = {
           ".nil?" => " is missing?"
         }
         gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def elsif_to_else_if(source_code, proc: false)
+      def elsif_to_else_if(source_code=print_method_source, proc: false)
         conversions = {
           "elsif" => "else if"
         }
         gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def remove_colons(source_code)
-        source_code.gsub(":", '')
+      def remove_colons(source_code=print_method_source, proc: proc)
+        conversions = {
+          ":" => ''
+        }
+        gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def ruby_operators_to_english(source_code, proc: false)
+      def ruby_operators_to_english(source_code=print_method_source, proc: false)
         conversions = {
           "&&"   => "and",
           ">="   => "is greater than or equal to",
@@ -188,23 +198,32 @@ module MarkdownRubyDocumentation
         gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def readable_ruby_numbers(source_code, proc: -> (value) { ActiveSupport::NumberHelper.number_to_delimited(value) })
+      def readable_ruby_numbers(source_code=print_method_source, proc: -> (replacement, _) { ActiveSupport::NumberHelper.number_to_delimited(replacement) })
         source_code.gsub(/([0-9][0-9_]+[0-9]+)/) do |match|
-          proc.call(eval(match))
+          proc.call(eval(match), match)
         end
       end
 
-      def convert_early_return_to_if_else(source_code, *)
-        source_code = source_code.gsub(/(.+) if (.+)/, "if \\2\n\\1\nend")
-        source_code.gsub(/(.+) unless (.+)/, "unless \\2\n\\1\nend")
+      def convert_early_return_to_if_else(source_code=print_method_source, proc: false)
+        conversions = {
+          /(.+) if (.+)/   => "if \\2\n\\1\nend",
+          /(.+) unless (.+)/ => "unless \\2\n\\1\nend"
+        }
+        gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def pretty_early_return(source_code, *)
-        source_code.gsub(/return (unless|if)/, 'return nothing \1')
+      def pretty_early_return(source_code=print_method_source, proc: false)
+        conversions = {
+          /return (unless|if)/   => 'return nothing \1'
+        }
+        gsub_replacement(source_code, conversions, proc: proc)
       end
 
-      def ternary_to_if_else(ternary, *)
-        ternary.gsub(/(.*) \? (.*) \: (.*)/, "if \\1\n\\2\nelse\n\\3\nend")
+      def ternary_to_if_else(source_code=print_method_source, proc: false)
+        conversions = {
+          /(.*) \? (.*) \: (.*)/   =>  "if \\1\n\\2\nelse\n\\3\nend"
+        }
+        gsub_replacement(source_code, conversions, proc: proc)
       end
 
       # @param [String] title the name of the link
@@ -334,11 +353,14 @@ module MarkdownRubyDocumentation
         end
       end
 
-      def constants_with_name_and_value(ruby_source, *)
+      def constants_with_name_and_value(ruby_source, proc: false)
         ruby_source.gsub(/([A-Z]+[A-Z_0-9]+)/) do |match|
           begin
-            value = ruby_class.const_get(match)
-            "[#{ConstantsPresenter.format(value)}](##{match.dasherize.downcase})"
+            value           = ruby_class.const_get(match)
+            link            = "##{match.dasherize.downcase}"
+            formatted_value = ConstantsPresenter.format(value)
+            replacement     = format_link(formatted_value, link)
+            proc ? proc.call(replacement, match, { value: value, link: link, formatted_value: formatted_value }) : replacement
           rescue NameError
             match
           end

data/lib/markdown_ruby_documentation/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRubyDocumentation
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_ruby_documentation
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -163,4 +163,3 @@ specification_version: 4
 summary: Gem provides the ability to use markdown and ruby ERB with some helper methods
   inside of comments
 test_files: []
-has_rdoc: