readme_spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77cad944e7ae512c01ee9b39769613b9a139a7c7
+  data.tar.gz: 4cbe6364f60b482948704329a33dc845ac1d6c62
+SHA512:
+  metadata.gz: 6886244745b13fe885b8daf26153593b70c7701f24477096dbb0c689010b982fa773e893bbca808ae2f91c5e49b283bd7a13e8a829ca6ec9cb6a04b3c5e62309
+  data.tar.gz: 6d7fc273d6c6cae2de729d95c08868ef3b784aa3b58479b4f43759a41ff5d7156adb99e6b2ebac186b4894ed1db356885e4617fd098c7f6ff47758c3525e8b5d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in readme_spec.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 gong023
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# ReadmeSpec
+[![Build Status](https://travis-ci.org/gong023/readme_spec.svg?branch=master)](https://travis-ci.org/gong023/readme_spec)
+
+Test your spec in README
+
+## Usage
+
+Set you readme file absolute path.
+
+```
+# spec_helper.rb
+RSpec.configure do |c|
+  c.readme_file_path = File.dirname(__FILE__) + '/../README.md'
+end
+```
+
+Write spec in README.
+
+<pre>
+Your awesome description.
+
+Your sample code.
+
+```ruby
+class YourClass
+  def do_something
+    true
+  end
+end
+
+your_class = YourClass.new
+expect(your_class.do_something).to be_true
+</pre>
+
+Call `ReadmeSpec.evaluate(binding)` in your test code.
+
+```
+expect { ReadmeSpec.evaluate(binding) }.not_to raise_error
+```
+
+Readme.evaluate evals your code in README sorrounded by `ruby`. You can keep correct code in README.md
+
+In this repository, below code is tested in `spec/`.
+
+```ruby
+a = 1
+b = 2
+expect(a + b).to be 3
+```
+
+If README code is wrong, you can get error message as it is.
+
+```
+Failure/Error: it { expect { ReadmeSpec.evaluate(binding) }.not_to raise_error }
+  expected no Exception, got #<RSpec::Expectations::ExpectationNotMetError:
+  expected #<Fixnum:3> => 1
+       got #<Fixnum:7> => 3
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/gong023/readme_spec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/readme_spec.rb

@@ -0,0 +1,97 @@
+require "readme_spec/version"
+require 'qiita-markdown'
+
+RSpec.configure do |config|
+  config.add_setting :readme_file_path
+end
+
+module ReadmeSpec
+  def self.evaluate(binding)
+    context = Context.new(binding)
+    config_path = Configure.new.load_path
+    content = File.new(config_path).load_content
+    Markdown.parse(content).ruby_codes.each { |c| context.evaluate(c.text) }
+  end
+
+  class Context
+    def initialize(binding)
+      @binding = binding
+    end
+
+    def evaluate(code)
+      @binding.eval(code)
+    end
+  end
+
+  class Configure
+    def load_path
+      validate
+      file_path
+    end
+
+    def validate
+      unless RSpec.configuration.readme_file_path?
+        raise ReadmeSpecMissingFilePathError
+      end
+    end
+
+    def file_path
+      RSpec.configuration.readme_file_path
+    end
+
+    class ReadmeSpecMissingFilePathError < Exception; end
+  end
+
+  class File
+    def initialize(path)
+      @path = path
+    end
+
+    def load_content
+      validate
+      content
+    end
+
+    def validate
+      unless ::File.file?(@path)
+        raise ReadmeSpecInvalidFileError, @path
+      end
+    end
+
+    def content
+      ::File.read(@path)
+    end
+
+    class ReadmeSpecInvalidFileError < Exception; end
+  end
+
+  class Markdown
+    def self.parse(content)
+      parser = ::Qiita::Markdown::Processor.new
+      self.new(parser.call(content))
+    end
+
+    def initialize(text)
+      @text = text
+    end
+
+    def ruby_codes
+      codes = @text[:codes].inject([]) { |codes, text| codes << Code.new(text) }
+      codes.select { |c| c.language === 'ruby' }
+    end
+
+    class Code
+      def initialize(pre_text)
+        @pre_text = pre_text
+      end
+
+      def text
+        @pre_text[:code]
+      end
+
+      def language
+        @pre_text[:language]
+      end
+    end
+  end
+end

data/lib/readme_spec/version.rb

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

data/readme_spec.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readme_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "readme_spec"
+  spec.version       = ReadmeSpec::VERSION
+  spec.authors       = ["gong023"]
+  spec.email         = ["gon.gong.gone@gmail.com"]
+  spec.summary       = %q{Guard spec in readme}
+  spec.description   = %q{Evaluate ruby code in your README.md}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'qiita-markdown', '>= 0.4.2'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "> 3.0.0"
+  spec.add_development_dependency "guard-rspec"
+end

data/spec/fixtures/HasInvalidRubyCode.md

@@ -0,0 +1,7 @@
+# invalid ruby code
+
+```ruby
+a = 1
+b = 2
+expect(a + b).to be 1
+```

data/spec/fixtures/HasValidRubyCode.md

@@ -0,0 +1,24 @@
+# test markdown
+
+description
+
+- hoge
+- fuga
+
+```ruby
+a = 1
+b = 2
+expect(a + 2).to be 3
+```
+
+```php
+$a = 1;
+$b = 2;
+$this->assertSame(3, $a + $b);
+```
+
+```
+a = 1i
+b = 2i
+assert_eq!(3i, a + b)
+```

data/spec/readme_spec/markdown_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe 'README' do
+  it { expect { ReadmeSpec.evaluate(binding) }.not_to raise_error }
+end
+
+describe ReadmeSpec do
+  subject { described_class }
+
+  context 'HasValidRubyCode' do
+    before(:context) do
+      RSpec.configure do |c|
+        c.readme_file_path = File.dirname(__FILE__) + '/../fixtures/HasValidRubyCode.md'
+      end
+    end
+    it { expect { subject.evaluate(binding) }.not_to raise_error }
+  end
+
+  context 'HasInvalidRubyCode' do
+    before(:context) do
+      RSpec.configure do |c|
+        c.readme_file_path = File.dirname(__FILE__) + '/../fixtures/HasInvalidRubyCode.md'
+      end
+    end
+
+    let(:expected_message) do
+<<'EOL'
+expected #<Fixnum:3> => 1
+     got #<Fixnum:7> => 3
+EOL
+    end
+
+    it { expect { subject.evaluate(binding) }.to raise_error(/#{expected_message}/) }
+  end
+
+  describe ReadmeSpec::Markdown do
+    context 'HasValidRubyCode' do
+      subject { described_class.parse(load_md('HasValidRubyCode')) }
+
+      context 'ruby_codes' do
+        subject { described_class.parse(load_md('HasValidRubyCode')).ruby_codes }
+
+        it 'returns only ruby code' do
+          expect(subject.size).to be 1
+        end
+
+        it { expect(subject.first).to be_instance_of ReadmeSpec::Markdown::Code }
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'readme_spec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.readme_file_path = File.dirname(__FILE__) + '/../README.md'
+end
+
+def load_md(file_name)
+  File.read("#{File.dirname(__FILE__)}/fixtures/#{file_name}.md")
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: readme_spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gong023
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: qiita-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+description: Evaluate ruby code in your README.md
+email:
+- gon.gong.gone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/readme_spec.rb
+- lib/readme_spec/version.rb
+- readme_spec.gemspec
+- spec/fixtures/HasInvalidRubyCode.md
+- spec/fixtures/HasValidRubyCode.md
+- spec/readme_spec/markdown_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Guard spec in readme
+test_files:
+- spec/fixtures/HasInvalidRubyCode.md
+- spec/fixtures/HasValidRubyCode.md
+- spec/readme_spec/markdown_spec.rb
+- spec/spec_helper.rb