specific 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01415a05773b182540b3d27c5f3655e2ef9a7550
+  data.tar.gz: 911c22b3cbbd382b056e8379fd7a1f42776a35dd
+SHA512:
+  metadata.gz: 97b7e728ab47263d1fa718390efc01c4649fee06d182ad389b46baa7326ef551989d4aea00dc960bd193cca05083c5d03acc51fdce4c78aac5211b6df32b63a4
+  data.tar.gz: 4cd47a300b96251f8ed190164563db3dd103b27b1e0bc420ac679deff85898e4701188480920bdaadb54767c3be9057b4a5f115b8b3978528c9830272e5a2707

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+features/*
+templates/*
+

data/.ruby-gemset

@@ -0,0 +1 @@
+gherkin-test

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# Specific
+
+Managing your project-specification programmatically with Gherkin
+
+## Some Words about all of this
+
+TODO: spit it out!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'specific'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install specific
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/specific

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+
+require 'specific'
+
+
+class CLI < Thor
+  desc "build TYPE", 
+    "builds your specification into the given type"
+  def build(type)
+    run :Build, type.to_sym
+  end
+
+  desc 'feature GROUP_NAME FILE_NAME FEATURE_TITLE', 
+    "adds an empty feature template into the group"
+  def feature(group_name, file_name, feature_title)
+    run :Feature, group_name, file_name, feature_title
+  end
+
+  private
+  def spec
+    unless @loader
+      @loader = Specific::Loader.new
+      @loader.run
+    end
+    @loader.spec
+  end
+
+  def run(name, *args)
+    Specific::Command.const_get(name).new(spec, *args).run
+  end
+end
+
+CLI.start
+
+exit 0
+
+cli = Specific::CLI.new(options)
+cli.run

data/lib/specific.rb

@@ -0,0 +1,39 @@
+require 'specific/feature'
+require 'specific/tag'
+require 'specific/group'
+require 'specific/scenario'
+require 'specific/step'
+
+require 'specific/processor'
+
+require 'specific/renderer'
+
+require 'specific/loader'
+require 'specific/command'
+
+module Specific
+  class Base
+    attr_reader :base_path
+
+    def initialize(base_path)
+      @base_path = base_path
+    end
+
+    def add_feature(feature)
+      features << feature
+    end
+
+    def features
+      @features ||= []
+    end
+
+    def next_id
+      highest_id + 1
+    end
+
+    private
+    def highest_id
+      features.map(&:id).max
+    end
+  end
+end

data/lib/specific/command.rb

@@ -0,0 +1,7 @@
+require 'specific/command/build'
+require 'specific/command/feature'
+
+module Specific
+  module Command
+  end
+end

data/lib/specific/command/build.rb

@@ -0,0 +1,17 @@
+module Specific
+  module Command
+    class Build
+      attr_reader :spec, :renderer
+
+      def initialize(spec, type)
+        @spec = spec
+        @type = type
+        @renderer =  Renderer.for(@type)
+      end
+
+      def run
+        puts renderer.new(spec).render
+      end
+    end
+  end
+end

data/lib/specific/command/feature.rb

@@ -0,0 +1,82 @@
+module Specific
+  module Command
+    class Feature
+      attr_reader :spec, :group_name, :file_name, :title
+
+      def initialize(spec, group_name, file_name, title)
+        @spec = spec
+        @group_name = group_name
+        @file_name = file_name
+        @title = title
+      end
+
+      def run
+        mk_group_dir
+        write_feature_template
+      end
+
+      private
+
+      def mk_group_dir
+        FileUtils.mkdir_p group_dir_path
+      end
+
+      def sanitized_group_name
+        group_name.gsub(' ', '-').downcase
+      end
+
+      def group_dir_path
+        dir_name = sanitized_group_name
+        File.join spec.base_path, dir_name
+      end
+
+      def feature_file_path
+        File.join(group_dir_path, file_name + ".feature")
+      end
+
+      def write_feature_template
+        template = <<-EOT
+          @id_[ID] @group_[GROUP]
+          Feature: [NAME]
+            In Order
+            As
+            I
+
+            Scenario:
+              Given
+              When
+              Then
+        EOT
+        template_intendation = template.match(/^(\s*)/)[1]
+        template.gsub!(/^#{template_intendation}/, '')
+
+        subs = {
+          'ID' => next_id,
+          'GROUP' => sanitized_group_name,
+          'NAME' => title,
+        }
+
+        subs.each do |key, value|
+          template.gsub!(/\[#{key}\]/, value.to_s)
+        end
+
+        if File.exist?(feature_file_path)
+          raise "File #{printable_feature_file_path} already exists"
+        end
+
+        File.open(feature_file_path, 'w')do |f|
+          f << template
+        end
+        puts "File #{printable_feature_file_path} created"
+      end
+
+      def next_id
+        spec.next_id
+      end
+
+      def printable_feature_file_path
+        feature_file_path.gsub(/^#{Dir.pwd}\//, '')
+      end
+    end
+  end
+end

data/lib/specific/feature.rb

@@ -0,0 +1,24 @@
+module Specific
+  class Feature < Struct.new(:name, :tags, :description, :scenarios)
+    attr_reader :id, :group
+
+    def initialize(*)
+      super
+      process!
+    end
+    private
+    def process!
+      process_tags!
+    end
+
+    def process_tags!
+      tags.each do |tag|
+        if tag.id?
+          @id = tag.id.to_i
+        elsif tag.group?
+          @group = Group.new(tag.group_name)
+        end
+      end
+    end
+  end
+end

data/lib/specific/group.rb

@@ -0,0 +1,4 @@
+module Specific
+  class Group < Struct.new(:name)
+  end
+end

data/lib/specific/loader.rb

@@ -0,0 +1,22 @@
+module Specific
+  class Loader
+    attr_reader :spec
+
+    def initialize(path = 'specification')
+      base_path = File.join(Dir.pwd, path)
+
+      @path = File.join(base_path, '**', '*.feature')
+      @spec = Specific::Base.new(base_path)
+    end
+
+    def run
+      Dir[@path].each do |feature_file|
+        feature_definition = File.read(feature_file)
+        ast = GherkinRuby.parse(feature_definition)
+
+        processor = Specific::Processor::Gherkin.new(@spec)
+        processor.execute(ast)
+      end
+    end
+  end
+end

data/lib/specific/processor.rb

@@ -0,0 +1,6 @@
+require 'specific/processor/gherkin'
+
+module Specific
+  module Processor
+  end
+end

data/lib/specific/processor/gherkin.rb

@@ -0,0 +1,36 @@
+require 'gherkin_ruby'
+
+module Specific
+  module Processor
+    class Gherkin
+      def initialize(spec)
+        @spec = spec
+      end
+
+      def execute(ast)
+        ast.accept(self)
+      end
+
+      def visit_Feature(ast_feature)
+        tags = ast_feature.tags.map do |ast_tag|
+          Specific::Tag.new(ast_tag.name)
+        end
+
+        scenarios = ast_feature.scenarios.map do |ast_scenario|
+          steps = ast_scenario.steps.map do |ast_step|
+            Specific::Step.new(ast_step.keyword, ast_step.name)
+          end
+          Specific::Scenario.new(ast_scenario.name, steps)
+        end
+
+        feature = Specific::Feature.new(
+          ast_feature.name, 
+          tags, 
+          ast_feature.description,
+          scenarios
+        )
+        @spec.add_feature feature
+      end
+    end
+  end
+end

data/lib/specific/renderer.rb

@@ -0,0 +1,34 @@
+require 'set'
+
+module Specific
+  module Renderer
+
+    def self.for(type)
+      renderer = Base.registered.detect do |renderer_class|
+        renderer_class.types.include? type
+      end 
+
+      renderer || raise("No Renderer for #{type.inspect} found")
+    end
+
+    module Base
+      def self.registered
+        @registered ||= Set.new
+      end
+      def self.included(cls)
+        Base.registered << cls
+        cls.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+        def types(*types)
+          @types = types unless types.empty?
+          @types || []
+        end
+      end
+    end
+  end
+end
+
+require 'specific/renderer/text'
+require 'specific/renderer/markdown'

data/lib/specific/renderer/markdown.rb

@@ -0,0 +1,58 @@
+module Specific
+  module Renderer
+    class Markdown
+      include Renderer::Base
+
+      types :md, :markdown
+
+      def initialize(spec)
+        @spec = spec
+      end
+
+      def render
+        out = "# Project Specific\n\n"
+
+        grouped_features = @spec.features.group_by(&:group)
+
+        grouped_features.each do |group, features|
+          group_title =  "## Features '#{group.name}'"
+
+          out << group_title + "\n\n"
+
+          features.each do |feature|
+            out << "* [#{feature_to_s feature}](#feature-#{feature.id})\n"
+          end
+
+          out << "\n"
+
+          features.sort_by(&:id).each do |feature|
+            out << [
+              "### #{feature_to_s feature}",
+              "<a href=\"feature-#{feature.id}\"></a>",
+              "\n"
+            ].join("\n")
+            out << feature.description.join(" \n") + "\n\n"
+
+            feature.scenarios.each do |scenario|
+              out << "#### Scenario: #{scenario.name}\n"
+              scenario.steps.each do |step|
+                out << "* #{step.keyword} #{step.text}\n"
+              end
+              out << "\n"
+            end
+
+            out << "\n"
+          end
+        end
+
+        out
+      end
+
+      private
+
+      def feature_to_s(feature)
+        ("[F%0.4d] - %s" % [feature.id, feature.name])
+      end
+    end
+  end
+end

data/lib/specific/renderer/text.rb

@@ -0,0 +1,32 @@
+module Specific
+  module Renderer
+    class Text
+      include Renderer::Base
+
+      types :text
+
+      def initialize(spec)
+        @spec = spec
+      end
+
+      def render
+        out = ""
+
+        grouped_features = @spec.features.group_by(&:group)
+
+        grouped_features.each do |group, features|
+          group_title =  "Group '#{group.name}'"
+
+          out << group_title + "\n"
+          out << "="*group_title.size + "\n"
+
+          features.sort_by(&:id).each do |feature|
+            out << ("  [F%0.4d] - %s" % [feature.id, feature.name]) + "\n"
+          end
+        end
+
+        out
+      end
+    end
+  end
+end

data/lib/specific/scenario.rb

@@ -0,0 +1,4 @@
+module Specific
+  class Scenario < Struct.new(:name, :steps)
+  end
+end

data/lib/specific/step.rb

@@ -0,0 +1,4 @@
+module Specific
+  class Step < Struct.new(:keyword, :text)
+  end
+end

data/lib/specific/tag.rb

@@ -0,0 +1,19 @@
+module Specific
+  class Tag < Struct.new(:name)
+    def id?
+      !!id
+    end
+
+    def group?
+      !!group_name
+    end
+
+    def id
+      @id ||= (name.match(/^id_(.+)$/) || [])[1]
+    end
+
+    def group_name
+      @group_name ||= (name.match(/^group_(.+)$/) || [])[1]
+    end
+  end
+end

data/lib/specific/version.rb

@@ -0,0 +1,3 @@
+module Specific
+  VERSION = '0.0.1'
+end

data/specific.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'specific/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "specific"
+  spec.version       = Specific::VERSION
+  spec.authors       = ["Jakob Holderbaum"]
+  spec.email         = ["jakob@featurefabrik.de"]
+  spec.summary       = %q{Write your usecases with gherkin.}
+  spec.homepage      = ""
+  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 "gherkin-ruby"
+  spec.add_dependency "thor"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: specific
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jakob Holderbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-12 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: gherkin-ruby
+  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'
+- !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: 
+email:
+- jakob@featurefabrik.de
+executables:
+- specific
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/specific
+- lib/specific.rb
+- lib/specific/command.rb
+- lib/specific/command/build.rb
+- lib/specific/command/feature.rb
+- lib/specific/feature.rb
+- lib/specific/group.rb
+- lib/specific/loader.rb
+- lib/specific/processor.rb
+- lib/specific/processor/gherkin.rb
+- lib/specific/renderer.rb
+- lib/specific/renderer/markdown.rb
+- lib/specific/renderer/text.rb
+- lib/specific/scenario.rb
+- lib/specific/step.rb
+- lib/specific/tag.rb
+- lib/specific/version.rb
+- specific.gemspec
+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: Write your usecases with gherkin.
+test_files: []