rspex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab08bdbbadaea4655f6b178d70dfa10b0d30e42b
+  data.tar.gz: 84d87b8fc74132edb3fbe2fc1c3d97ded5ccb6bf
+SHA512:
+  metadata.gz: 4f8e0f336f9e66126c3687f3229fb2cab82620cf1b054bfd6271c07901d41b75b46b04722b918fa110bc06f3b13bfdcb9adb55617131cc63fd38d190125b7ca9
+  data.tar.gz: 361be64e0165cc7b43dfb80e3b47d0ba31a88e79ac58c68686ea13d51a329c17a4ebc07aa116adaa1e06f72d9e4b4e0df51d3a0072a486510bbae281ec0a37d5

data/.gitignore

@@ -0,0 +1 @@
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color -f d

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'guard-rspec'
+gem 'terminal-notifier-guard'
+gem 'pry-byebug'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    rspex (0.0.1)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (2.3.1)
+      columnize (~> 0.3.6)
+      debugger-linecache (~> 1.2.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    columnize (0.3.6)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.4)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.0.4)
+      guard (>= 2.1.1)
+      rspec (~> 2.14)
+    listen (2.2.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    pry (0.9.12.3)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-byebug (1.2.0)
+      byebug (~> 2.2)
+      pry (~> 0.9.12)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.7)
+    terminal-notifier-guard (1.5.3)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  guard-rspec
+  pry-byebug
+  rake
+  rspec
+  rspex!
+  terminal-notifier-guard

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 aq2bq
+
+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,40 @@
+# RSpex
+
+Learn how to writing spec in English from local gem's spec-files  
+
+![](https://dl.dropboxusercontent.com/u/10198795/rspex_screenshot.png)
+
+## Installation
+
+    $ gem install rspex
+
+## Usage
+
+### search from 'it' sentence
+
+    $ rspex it 'keyword'
+
+
+### search from 'context' sentence
+
+    $ rspex context 'keyword'
+
+
+### search from 'describe' sentence
+
+    $ rspex describe 'keyword'
+
+
+## TODO
+
+1. Must be Improve performance (It takes 15sec with loading 2500 spec files! )
+2. Make to configurable
+3. Use Regular Expression
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rspex

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rspex'
+
+RSpex::CLI.start

data/fake/gems/fakegem-1.0.0/spec/fake_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Fake do
+  describe '.create' do
+    context "when params are valid" do
+      it "returns true" do
+        expect(subject).to be_true
+      end
+    end
+    context "when params are invalid" do
+      it "returns false" do
+        expect(subject).to be_false
+      end
+    end
+  end
+end
+

data/lib/rspec_examples.rb

@@ -0,0 +1,56 @@
+class RSpecExamples
+  SPEC_PATH = "#{Gem.path[0]}/gems/*/spec/**/*_spec.rb"
+  attr_reader :examples, :size
+
+  def initialize(spec_path=SPEC_PATH)
+    @examples = Dir.glob(spec_path).map{|path| Example.new(path)}
+  end
+
+  def search word, type
+    @examples.select{|example| example.matches word, type }
+  end
+
+  def size
+    @examples.size
+  end
+end
+
+
+class Example
+  attr_reader :path, :all, :describes, :contexts, :its, :results
+
+  def initialize path
+    raise ('argument must be path to spec file') unless valid?(path)
+    @path = path
+    @all = open(path).read
+    @results = []
+    types = %w(describe context it)
+    types.each{|type| self.instance_variable_set("@#{type}s",[])}
+    
+    @all.each_line do |line|
+      types.each do |type|
+        examples(type) << line.chomp.strip if line =~ /.*#{type} .* do$/
+      end
+    end
+  end
+
+  def name
+    @path.match(/^.*gems\/(.*)\/spec\//)[1]
+  end
+
+  def matches word, type
+    if examples(type).any?
+      @results = examples(type).select{|example| example.include? word}
+    end
+    @results.any? ? @results : false
+  end
+
+  private
+  def examples(type)
+    self.instance_variable_get("@#{type}s")
+  end
+
+  def valid?(path)
+    Pathname.new(path).exist? and path.include?('spec.rb')
+  end
+end

data/lib/rspex.rb

@@ -0,0 +1,11 @@
+require "rspex/version"
+require "rspex/cli"
+require 'rspec_examples'
+
+module RSpex
+  class << self
+    def examples
+      @examples = RSpecExamples.new
+    end
+  end
+end

data/lib/rspex/cli.rb

@@ -0,0 +1,34 @@
+require "rspex"
+require 'thor'
+
+module RSpex
+  class CLI < Thor
+    desc "it 'keyword'", "search keyword from 'it' sentence."
+    def it(word)
+      search word, 'it'
+    end
+
+    desc "context 'keyword'", "search keyword from 'context' sentence."
+    def context(word)
+      search word, 'context'
+    end
+    
+    desc "describe 'keyword'", "search keyword from 'describe' sentence."
+    def describe(word)
+      search word, 'describe'
+    end
+
+    private
+    def search word, type
+      i = 0
+      examples = RSpex.examples
+      results = examples.search(word, type)
+      results.each do |example|
+        say("\n[#{example.path}]", :on_blue)
+        example.results.each{|result| say(result, :on_black)}
+        i += example.results.size
+      end
+      say("\nfound #{i} example(s) on #{results.size}/#{examples.size} spec(s)", :on_red)
+    end
+  end
+end

data/lib/rspex/version.rb

@@ -0,0 +1,3 @@
+module RSpex
+  VERSION = "0.0.1"
+end

data/rspex.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspex"
+  spec.version       = RSpex::VERSION
+  spec.authors       = ["@aq2bq"]
+  spec.email         = ["terada@yukashikado.co.jp"]
+  spec.description   = %q{Learn how to writing spec in English from local gem's spec-files}
+  spec.summary       = %q{Learn how to writing spec in English from local gem's spec-files}
+  spec.homepage      = "https://twitter.com/aq2bq"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency 'thor'
+end

data/spec/rspec_examples_spec.rb

@@ -0,0 +1,73 @@
+require 'rspec_examples'
+
+describe RSpecExamples do
+  before do
+    @rspec_examples = RSpecExamples.new("fake/gems/*/spec/**/*_spec.rb")
+  end
+
+  let(:word) { 'valid' }
+  let(:type) { 'context' }
+
+  describe '#search' do
+    before do
+      @search = @rspec_examples.search(word, type)
+    end
+    
+    context "Success in Search" do
+      it { expect(@search.first.name).to eq "fakegem-1.0.0" }
+      it { expect(@search.first.results).to eq ["context \"when params are valid\" do", "context \"when params are invalid\" do"] }
+    end
+
+    context "Fail in Search" do
+      let(:type) { 'describe' }
+      it { expect(@search).to be_empty }
+    end
+  end
+end
+
+describe Example do
+  let(:path) { "fake/gems/fakegem-1.0.0/spec/fake_spec.rb" }
+  before do
+    @example = Example.new(path)
+  end
+
+  describe '#attr_reader' do
+    context "with a valid path" do
+      it { expect(@example.all).to eq "require 'spec_helper'\n\n\ndescribe Fake do\n  describe '.create' do\n    context \"when params are valid\" do\n      it \"returns true\" do\n        expect(subject).to be_true\n      end\n    end\n    context \"when params are invalid\" do\n      it \"returns false\" do\n        expect(subject).to be_false\n      end\n    end\n  end\nend\n\n" }
+      it { expect(@example.describes).to have(2).items }
+      it { expect(@example.describes.first).to eq "describe Fake do" }
+      it { expect(@example.contexts).to have(2).items }
+      it { expect(@example.contexts.first).to eq "context \"when params are valid\" do" }
+      it { expect(@example.its).to have(2).items }
+      it { expect(@example.its.first).to eq "it \"returns true\" do" }
+    end
+  end
+
+  describe '#name' do
+    context "with a valid path" do
+      it { expect(@example.name).to eq 'fakegem-1.0.0' }
+    end
+    context "with an invalid path" do
+      it { expect{Example.new('x')}.to raise_error('argument must be path to spec file') }
+    end
+  end
+
+  describe '#matches' do
+    before do
+      @matches = @example.matches(word, type)
+    end
+    let(:type) { 'context' }
+
+    context "Success in match the word" do
+      let(:word) { 'valid' }
+      it { expect(@matches).to have(2).items }
+      it { expect(@example.results).to eq ["context \"when params are valid\" do", "context \"when params are invalid\" do"] }
+    end
+    
+    context "Fail in match the word" do
+      let(:word) { 'xxx' }
+      it { expect(@matches).to be_false }
+      it { expect(@example.results).to be_empty }
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rspex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- '@aq2bq'
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Learn how to writing spec in English from local gem's spec-files
+email:
+- terada@yukashikado.co.jp
+executables:
+- rspex
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rspex
+- fake/gems/fakegem-1.0.0/spec/fake_spec.rb
+- lib/rspec_examples.rb
+- lib/rspex.rb
+- lib/rspex/cli.rb
+- lib/rspex/version.rb
+- rspex.gemspec
+- spec/rspec_examples_spec.rb
+homepage: https://twitter.com/aq2bq
+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: Learn how to writing spec in English from local gem's spec-files
+test_files:
+- spec/rspec_examples_spec.rb