markdown_ruby_documentation 0.1.0

data/lib/markdown_ruby_documentation/version.rb

@@ -0,0 +1,3 @@
+module MarkdownRubyDocumentation
+  VERSION = "0.1.0"
+end

data/lib/markdown_ruby_documentation/write_markdown_to_disk.rb

@@ -0,0 +1,29 @@
+module MarkdownRubyDocumentation
+  class WriteMarkdownToDisk
+
+    attr_reader :dir, :skip_if_blank
+
+    def initialize(dir:, skip_if_blank: false)
+      @dir           = dir
+      @skip_if_blank = skip_if_blank
+    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)
+    end
+
+    private
+
+    def skip_save?(text, name)
+      if skip_if_blank
+        if Array(text.split("\n")[2..-1]).all? { |line| line.blank? }
+          return true
+        end
+      end
+    end
+  end
+end

data/markdown_ruby_documenation.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markdown_ruby_documentation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdown_ruby_documentation"
+  spec.version       = MarkdownRubyDocumentation::VERSION
+  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.homepage      = "https://github.com/zeisler/markdown_ruby_documentation"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.1"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "method_source", "~> 0.8.2"
+  spec.add_runtime_dependency "activesupport", ">= 4.1"
+  spec.add_runtime_dependency "ruby-progressbar", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: markdown_ruby_documentation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dustin Zeisler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- dustin@zeisler.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/github-markdown.css
+- lib/markdown_ruby_documentation.rb
+- lib/markdown_ruby_documentation/constants_presenter.rb
+- lib/markdown_ruby_documentation/default_erb_methods.rb
+- lib/markdown_ruby_documentation/generate.rb
+- lib/markdown_ruby_documentation/git_hub_link.rb
+- lib/markdown_ruby_documentation/git_hub_project.rb
+- lib/markdown_ruby_documentation/instance_to_class_methods.rb
+- lib/markdown_ruby_documentation/markdown_presenter.rb
+- lib/markdown_ruby_documentation/method.rb
+- lib/markdown_ruby_documentation/method/class_method.rb
+- lib/markdown_ruby_documentation/method/instance_method.rb
+- lib/markdown_ruby_documentation/method/null_method.rb
+- lib/markdown_ruby_documentation/method_linker.rb
+- lib/markdown_ruby_documentation/print_method_source.rb
+- lib/markdown_ruby_documentation/reject_blank_methods.rb
+- lib/markdown_ruby_documentation/summary.rb
+- lib/markdown_ruby_documentation/template_parser.rb
+- lib/markdown_ruby_documentation/version.rb
+- lib/markdown_ruby_documentation/write_markdown_to_disk.rb
+- markdown_ruby_documenation.gemspec
+homepage: https://github.com/zeisler/markdown_ruby_documentation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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
+test_files: []