markdown_ruby_documentation 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6dfcca51c06892aecf2b21ed0ebc2990b5ecf9a
-  data.tar.gz: f33ca187bb9c49faf504ff50b21f118183b6a8d3
+  metadata.gz: 94cf45206406b64001109a7c6d3ab7ae25558135
+  data.tar.gz: 45986afae8718ada4c88ca45f6aa8c3985c505dd
 SHA512:
-  metadata.gz: e1b8645d4b2178ea543083bd72dfba5390de5e48e0331949bf188c5d014d9fa848fec25949d61da79a38379d370da3e9b79775157e87ba8ca3a2aab593e96634
-  data.tar.gz: f213dc69ceb6592eda622c7b2560e6179ef61faa444fcb3baffe421ce595d3e4be3a55fc0d49df6cb661f586cd20a81dcf4b98b862d16937239c77bae506da3f
+  metadata.gz: 18f90760acfe91488781e2a1a06d4b7f4b1deb83c7839bd81d6be1e91626ff8a24470dde8d59e883d6fb4de42ec1e47de011cec15114808eb1ac374ff4c6f94d
+  data.tar.gz: d2c99a00987c550646e368e1e84399a860c3bf416b816c865496c7a903bf6d1f1f5d596c8c944e55ae2ed2a70c28b198aa15950d23c9b227dd80d266fb3a4fb4

data/README.md

@@ -1,6 +1,12 @@
 # MarkdownRubyDocumentation
+Documentation DSL that provides method level comments and links or imports to other comments. 
+Comments can be written in MarkDown format and the current method can be transformed from Ruby code into a MarkDown readable format.
+Static instance, class methods, and constants can be called and used inside of ERB tags.
+All defined areas are generated into markdown file per class.
 
-Gem provides the ability to use markdown and ruby ERB with some helper methods inside of comments. The comment area then can be generated into a markdown file.
+## Why should you use this?
+
+Allows creating business or technical documentation that can stays automatically in sync with Ruby Logic and available data.
 
 ## Installation
 
@@ -27,7 +33,7 @@ class RubyClassToBeInspected
   #=mark_doc
   # **I am Documentation**
   # <%= print_method_source "#i_am_a_documented_method" %>
-  # ^`MY_VALUE`
+  # <%= MY_VALUE %>
   #=mark_end
   def i_am_a_documented_method
     "Hello"
@@ -53,17 +59,22 @@ MarkdownRubyDocumentation::Generate.run(
 
 **I am Documentation**
 "Hello"
-[MY_VALUE](/ruby_class_to_be_inspected#my_value)
+10
 
 ```
 
 ### ERB Methods
 
+### String Method Reference (method)
+* Call an instance method in the current context with `"#method_name"` (Limitations: methods cannot take any arguments or depend on any uninitialized state, they may call other methods that follow this same requirements.)
+* Call an class method in the current context with `".method_name"`
+* Call an instance method from another class `"OtherClass#method_name"`
+
 #### `print_method_source(method)`
 The source of a method block returned as text.
 
 #### `eval_method(method)`
-The result of evaluating a method.
+The result of evaluating a method. 
 
 #### `print_mark_doc_from(method)`
 Prints out the mark doc from another method.
@@ -79,7 +90,7 @@ Creates a url to the file on GitHub based on the current sha or it defaults to m
 
 ##### `link_to_markdown` or `link_to`(klass_or_path, title: String)
 @param [Class, String, Pathname] klass_or_path
-  1. String or Class representing a method reference
+  1. String or Class representing a method reference ie. MyObject#call, MyObject.name
   2. Pathname representing the full path of the file location a method is defined
 @param [String] title is the link display value
 @return [String, Symbol] Creates link to a given generated markdown file or returns :non_project_location message.

data/lib/markdown_ruby_documentation/version.rb

@@ -1,3 +1,3 @@
 module MarkdownRubyDocumentation
-  VERSION = "0.20.2"
+  VERSION = "0.21.0"
 end

data/lib/markdown_ruby_documentation/write_markdown_to_disk.rb

@@ -6,24 +6,33 @@ module MarkdownRubyDocumentation
     def initialize(dir:, skip_if_blank: false, relative_dir:)
       @dir           = dir
       @skip_if_blank = skip_if_blank
-      @relative_dir = relative_dir
+      @relative_dir  = relative_dir
     end
 
     def call(name:, text:)
       return if skip_save?(text, name)
       name = name.gsub(dir, "").underscore
-      path = File.join(dir, name)
-      FileUtils.mkdir_p(path.split("/").tap { |p| p.pop }.join("/"))
-      File.open("#{path}.md", "w").write(text)
+      file = "#{name}.md"
+      path = File.join(dir, file)
+
+      return if file_exists_with?(text, path)
+      write_file(path, text)
     end
 
     private
 
-    def skip_save?(text, name)
+    def file_exists_with?(text, path)
+      File.exist?(path) && Digest::MD5.new.update(File.open(path).read) == Digest::MD5.new.update(text)
+    end
+
+    def write_file(path, text)
+      FileUtils.mkdir_p(path.split("/").tap { |p| p.pop }.join("/"))
+      File.open(path, "w").write(text)
+    end
+
+    def skip_save?(text, _name)
       if skip_if_blank
-        if Array(text.split("\n")[2..-1]).all? { |line| line.blank? }
-          return true
-        end
+        return true if Array(text.split("\n")[2..-1]).all?(&:blank?)
       end
     end
   end

data/markdown_ruby_documenation.gemspec

@@ -9,8 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Dustin Zeisler"]
   spec.email         = ["dustin@zeisler.net"]
 
-  spec.summary       = %q{Gem provides the ability to use markdown and ruby ERB with some helper methods inside of comments}
-  spec.description   = %q{Gem provides the ability to use markdown and ruby ERB with some helper methods inside of comments. The comment area then can be generated into a markdown file.}
+  spec.summary       = %q{Allows creating business or technical documentation that can stays automatically in sync with Ruby Logic and available data.}
+  spec.description   = %q{Documentation DSL that provides method level comments and links or imports to other comments.
+Comments can be written in MarkDown format and the current method can be transformed from Ruby code into a MarkDown readable format.
+Static instance, class methods, and constants can be called and used inside of ERB tags.
+All defined areas are generated into markdown file per class.}
   spec.homepage      = "https://github.com/zeisler/markdown_ruby_documentation"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_ruby_documentation
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - Dustin Zeisler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-25 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -94,9 +94,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Gem provides the ability to use markdown and ruby ERB with some helper
-  methods inside of comments. The comment area then can be generated into a markdown
-  file.
+description: |-
+  Documentation DSL that provides method level comments and links or imports to other comments.
+  Comments can be written in MarkDown format and the current method can be transformed from Ruby code into a MarkDown readable format.
+  Static instance, class methods, and constants can be called and used inside of ERB tags.
+  All defined areas are generated into markdown file per class.
 email:
 - dustin@zeisler.net
 executables: []
@@ -161,6 +163,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Gem provides the ability to use markdown and ruby ERB with some helper methods
-  inside of comments
+summary: Allows creating business or technical documentation that can stays automatically
+  in sync with Ruby Logic and available data.
 test_files: []