mouse_melon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0cbac59d8c02e88a4bda4f237319b533b92b6630
+  data.tar.gz: 75389d980d9614e48186694ee6d99f52c7d1436d
+SHA512:
+  metadata.gz: e557a23cb19c61b35c5de25e25f78382df3c1c77785ac953d4b200ef35d14ca454cb7e56a9741df1417fbe105009be6011022c2e66599460d425e52839aaf89d
+  data.tar.gz: a45536b1063a7ca20510ebd853faf71331da01e90c22d1b5cfc9fa53d377e47d7bbbe1e0f1cd45822065b53c2026ec277ba507a614cc288d4a98047a3887a947

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.4
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vojtech Kusy
+
+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,125 @@
+# MouseMelon a.k.a. Mexikan Gherkin
+
+MouseMelon is a pseudo-Gherkin DSL designed to be used in RSpec acceptance specs but it may be used elsewhere.
+
+Notable features:
+
+  * It runs inside RSpec (Minispec will come later), just include module and you're ready
+  * `Given`, `When`, `Then` are just methods which calls the step definitions directly
+  * You can use symbols `I_am_registered_user` or feature steps `I am registered user`
+  * You can define the steps globally, locally or mix them into the specs
+  * Steps can have arguments `I register user`
+  * Command line tool to generate step definitions
+  * No fancy output of tested steps like Cucumber or Spinach
+
+Currently supported/tested environment:
+
+  * RSpec 3.3.x
+  * Ruby 2.1.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mouse_melon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mouse_melon
+
+Include it to RSpec helper
+
+```ruby
+  RSpec.configure do |config|
+    config.include MouseMelon::DSL, :type => :feature
+  end
+```
+
+## Usage
+
+Here is demonstration of varios possible styles:
+
+```ruby
+feature 'MouseMelon features' do
+  # Steps shared via modules
+  include CommonSteps
+
+  scenario 'Steps as methods' do
+    given_is_defined
+    when_is_defined
+    then_is_defined
+  end
+
+  scenario 'Steps as symbols' do
+    Given :given_is_defined
+     When :when_is_defined
+     Then :then_is_defined
+  end
+
+  scenario 'Steps as strings' do
+    Given 'given is defined'
+     When 'when is defined'
+     Then 'then is defined'
+      And 'and is defined'
+      And 'and it has arguments', 'hello', 1
+  end
+
+  scenario 'Steps as triangle bullets' do
+    ‣ 'given is defined'
+    ‣ 'when is defined'
+    ‣ 'then is defined'
+  end
+
+  scenario 'Steps as circle bullets' do
+    • 'given is defined'
+    • 'when is defined'
+    • 'then is defined'
+  end
+
+  # INLINE STEP DEFINITIONS
+
+  def given_is_defined
+    puts 'GIVEN'
+  end
+
+  def when_is_defined
+    puts 'WHEN'
+  end
+
+  step 'then is defined' do
+    puts 'THEN'
+  end
+
+  step 'and is defined' do
+    puts 'AND'
+  end
+
+  step 'and it has arguments' do |*args|
+    puts "AND with args #{args.inspect}"
+  end
+end
+```
+
+For more examples look inside `examples` and `spec` folders.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mouse_melon. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mouse_melon'
+require 'mouse_melon/tools'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/login/login.feature

@@ -0,0 +1,25 @@
+Feature: Login
+  As a registered user
+  I want to be able to login
+
+  Background:
+    Given I am registered user
+
+  Scenario: Successfull login with username
+    When I am on the home page
+    And I click on login link
+    And I submit my username and password
+    Then I should be on the dashboard page
+
+  Scenario: Successfull login with email
+    When I am on the home page
+    And I click on login link
+    And I submit my email and password
+    Then I should be on the dashboard page
+
+  Scenario: Unsuccessfull login
+    When I am on the home page
+    And I click on login link
+    And I submit my email and wrong password
+    Then I should be on the login page
+    And I should see form errors

data/examples/login/login_spec.rb

@@ -0,0 +1,31 @@
+feature 'Login' do
+  # As a registered user
+  # I want to be able to login
+
+  before do
+    Given 'I am registered user'
+  end
+
+  scenario 'Successfull login with username' do
+    When 'I am on the home page'
+    And 'I click on login link'
+    And 'I submit my username and password'
+    Then 'I should be on the dashboard page'
+  end
+
+  scenario 'Successfull login with email' do
+    When 'I am on the home page'
+    And 'I click on login link'
+    And 'I submit my email and password'
+    Then 'I should be on the dashboard page'
+  end
+
+  scenario 'Unsuccessfull login' do
+    When 'I am on the home page'
+    And 'I click on login link'
+    And 'I submit my email and wrong password'
+    Then 'I should be on the login page'
+    And 'I should see form errors'
+  end
+
+end

data/examples/varations/common_steps.rb

@@ -0,0 +1,15 @@
+module CommonSteps
+  extend MouseMelon::DSL::StepDefinitions
+
+  def step_can_be_included1
+    puts 'INCLUDED 2'
+  end
+
+  def step_can_be_included2
+    puts 'INCLUDED 2'
+  end
+
+  step 'step can be included3' do
+    puts 'INCLUDED 2'
+  end
+end

data/examples/varations/mouse_melon_spec.rb

@@ -0,0 +1,92 @@
+require_relative 'spec_helper'
+require_relative 'common_steps'
+
+describe MouseMelon do
+  it 'has a version number' do
+    expect(MouseMelon::VERSION).not_to be nil
+  end
+end
+
+feature 'MouseMelon features' do
+  include CommonSteps
+
+  scenario 'Without gherkin' do
+    given_is_defined
+    when_is_defined
+    then_is_defined
+    and_is_defined
+    step_is_defined
+    step_can_have_arguments1('X')
+    step_can_be_included1
+  end
+
+  scenario 'Gherkin steps as symbols' do
+    Given :given_is_defined
+     When :when_is_defined
+     Then :then_is_defined
+      And :and_is_defined
+     Step :step_is_defined
+      And :step_can_have_arguments2, 'Y'
+      And :step_can_be_included2
+  end
+
+  scenario 'Gherkin steps as strings' do
+    Given 'given is defined'
+     When 'when is defined'
+     Then 'then is defined'
+      And 'and is defined'
+     Step 'step is defined'
+      And 'step can have arguments3', 'Z'
+      And 'step can have "quotes"3'
+      And 'step can be included3'
+  end
+
+  scenario 'Gherkin steps as triangle bullets' do
+    ‣ 'given is defined'
+    ‣ 'when is defined'
+    ‣ 'then is defined'
+  end
+
+  scenario 'Gherkin steps as circle bullets' do
+    • 'given is defined'
+    • 'when is defined'
+    • 'then is defined'
+  end
+
+  def given_is_defined
+    puts 'GIVEN'
+  end
+
+  def when_is_defined
+    puts 'WHEN'
+  end
+
+  def then_is_defined
+    puts 'THEN'
+  end
+
+  def and_is_defined
+    puts 'AND'
+  end
+
+  step 'step is defined' do
+    puts 'STEP'
+  end
+
+  step 'step can have "quotes"3' do
+    puts "QUOTES 3"
+  end
+
+  def step_can_have_arguments1(arg)
+    puts "STEP #{arg}"
+  end
+
+  def step_can_have_arguments2(arg)
+    puts "STEP #{arg}"
+  end
+
+  step 'step can have arguments3' do |arg|
+    puts "STEP #{arg}"
+  end
+
+end

data/exe/mouse_melon

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mouse_melon/tools'
+
+ARGV.each do |file|
+  string = File.read(file)
+  steps = MouseMelon::Tools::SpecStepsReport.new(string)
+  puts steps.report
+end

data/lib/mouse_melon.rb

@@ -0,0 +1,5 @@
+require_relative 'mouse_melon/version'
+require_relative 'mouse_melon/dsl'
+
+module MouseMelon
+end

data/lib/mouse_melon/dsl.rb

@@ -0,0 +1,60 @@
+module MouseMelon
+
+  class StepNotFound < StandardError
+    def initialize(name)
+      @method_name = name
+      @step_name = name.to_s.gsub(/_/, ' ')
+      super "undefined step '#{@step_name}'
+
+Please define the step by one of the following definition:
+
+step \"#{@step_name}\" do
+end
+
+or
+
+def #{@method_name} do
+end
+"
+    end
+  end
+
+  module DSL
+
+    module StepDefinitions
+      def step(name, *args, &block)
+        normalized_name = name.to_s.gsub(/ /, '_')
+        define_method(normalized_name, *args, &block)
+      end
+    end
+
+    module ScenarioDefinitions
+      def Step(name, *args)
+        normalized_name =
+            case name
+            when Symbol
+              name
+            when String
+              name.to_s.gsub(/ /, '_')
+            else
+              raise ArgumentError.new("Expects Symbol or String but #{name.inspect} was given")
+            end
+        raise StepNotFound.new(normalized_name) unless respond_to?(normalized_name)
+        send(normalized_name, *args)
+      end
+      alias :Given :Step
+      alias :When  :Step
+      alias :Then  :Step
+      alias :And   :Step
+      alias :But   :Step
+      alias :‣     :Step
+      alias :•     :Step
+    end
+
+    def self.included(base)
+      base.extend StepDefinitions
+      base.include ScenarioDefinitions
+    end
+
+  end
+end

data/lib/mouse_melon/step_definition.rb

@@ -0,0 +1,17 @@
+module MouseMelon
+  class StepDefinition
+    attr_reader :name, :body, :spaces
+
+    def initialize(name, body: nil, spaces: 0)
+      @name, @body, @spaces = name, body, spaces
+    end
+
+    def code
+      prefix = " " * @spaces
+      out =  "#{prefix}step '#{name}' do\n"
+      out << "#{prefix}  #{body}\n" if body
+      out << "#{prefix}end\n"
+    end
+    alias :to_s :code
+  end
+end

data/lib/mouse_melon/tools.rb

@@ -0,0 +1,11 @@
+require_relative 'step_definition'
+require_relative 'tools/feature_steps_parser'
+require_relative 'tools/step_definitions_parser'
+require_relative 'tools/spec_steps_report'
+require_relative 'tools/spec_steps_result'
+require_relative 'tools/basic_report_formatter'
+
+module MouseMelon
+  module Tools
+  end
+end

data/lib/mouse_melon/tools/basic_report_formatter.rb

@@ -0,0 +1,38 @@
+module MouseMelon
+  module Tools
+    class BasicReportFormatter
+
+      def format(report)
+        @report = report
+"
+DEFINED:
+#{defined_steps_list}
+
+UNUSED:
+#{unused_steps_list}
+
+MISSING:
+
+#{missing_steps_list}
+"
+      end
+
+    protected
+
+      def defined_steps_list(spaces: 2)
+        prefix = " " * spaces
+        @report.implemented_steps.map { |step| "#{prefix}#{step}" }.join("\n")
+      end
+
+      def unused_steps_list(spaces: 2)
+        prefix = " " * spaces
+        @report.unused_steps.map { |step| "#{prefix}#{step}" }.join("\n")
+      end
+
+      def missing_steps_list
+        @report.not_implemented_steps.map { |name| StepDefinition.new(name, spaces: 2).to_s }.join("\n")
+      end
+
+    end
+  end
+end

data/lib/mouse_melon/tools/feature_steps_parser.rb

@@ -0,0 +1,34 @@
+module MouseMelon
+  module Tools
+    class FeatureStepsParser
+
+      def parse(string)
+        @steps = find_steps(string)
+        strip_step_arguments
+        strip_end_quotes
+        drop_duplicate_steps
+      end
+
+    protected
+
+      def find_steps(string)
+        string.scan(/^\s*(?:Given|When|Then|And|But|Step)\s+['"](.+)['"]$/).flatten
+      end
+
+      def drop_duplicate_steps
+        @steps.uniq!
+      end
+
+      def strip_end_quotes
+        @steps.map { |step| step.gsub(/\A["']+|["']+\z/, '') }
+      end
+
+      def strip_step_arguments
+        @steps = @steps.map do |step|
+          step.split(/['"], /).first
+        end
+      end
+
+    end
+  end
+end

data/lib/mouse_melon/tools/spec_steps_report.rb

@@ -0,0 +1,30 @@
+module MouseMelon
+  module Tools
+    class SpecStepsReport
+
+      attr_reader :feature, :result
+
+      def initialize(feature, formatter = nil)
+        @feature = feature
+        feature_steps = feature_parser.parse(feature)
+        defined_steps = definition_parser.parse(feature)
+        @result = SpecStepsResult.new(feature_steps, defined_steps)
+        @formatter = formatter || BasicReportFormatter.new
+      end
+
+      def feature_parser
+        FeatureStepsParser.new
+      end
+
+      def definition_parser
+        StepDefinitionsParser.new
+      end
+
+      def report
+        @formatter.format(self.result)
+      end
+      alias :to_s :report
+
+    end
+  end
+end

data/lib/mouse_melon/tools/spec_steps_result.rb

@@ -0,0 +1,28 @@
+require 'set'
+
+module MouseMelon
+  module Tools
+    class SpecStepsResult
+
+      attr_reader :feature_steps, :defined_steps
+
+      def initialize(feature_steps, defined_steps)
+        @feature_steps = Set.new(feature_steps)
+        @defined_steps = Set.new(defined_steps)
+      end
+
+      def not_implemented_steps
+        feature_steps - defined_steps
+      end
+
+      def unused_steps
+        defined_steps - feature_steps
+      end
+
+      def implemented_steps
+        defined_steps - unused_steps
+      end
+
+    end
+  end
+end

data/lib/mouse_melon/tools/step_definitions_parser.rb

@@ -0,0 +1,26 @@
+module MouseMelon
+  module Tools
+    class StepDefinitionsParser
+
+      def parse(string)
+        @steps = find_steps(string)
+        strip_end_quotes
+      end
+
+    protected
+
+      def find_steps(string)
+        string.scan(/^\s*step\s+['"](.+)['"]/).flatten
+      end
+
+      def drop_duplicate_steps
+        @steps.uniq!
+      end
+
+      def strip_end_quotes
+        @steps.map { |step| step.gsub(/\A["']+|["']+\z/, '') }
+      end
+
+    end
+  end
+end

data/lib/mouse_melon/version.rb

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

data/mouse_melon.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mouse_melon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mouse_melon"
+  spec.version       = MouseMelon::VERSION
+  spec.authors       = ["Vojtech Kusy"]
+  spec.email         = ["wojtha@gmail.com"]
+
+  spec.summary       = "mouse_melon-#{MouseMelon::VERSION}"
+  spec.description   = "MouseMelon is a simple DSL which allows to write acceptance specs in Gherkin-like language without any parser."
+  spec.homepage      = "http://github.com/wojtha/mouse_melon"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: mouse_melon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vojtech Kusy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MouseMelon is a simple DSL which allows to write acceptance specs in
+  Gherkin-like language without any parser.
+email:
+- wojtha@gmail.com
+executables:
+- mouse_melon
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/login/login.feature
+- examples/login/login_spec.rb
+- examples/varations/common_steps.rb
+- examples/varations/mouse_melon_spec.rb
+- exe/mouse_melon
+- lib/mouse_melon.rb
+- lib/mouse_melon/dsl.rb
+- lib/mouse_melon/step_definition.rb
+- lib/mouse_melon/tools.rb
+- lib/mouse_melon/tools/basic_report_formatter.rb
+- lib/mouse_melon/tools/feature_steps_parser.rb
+- lib/mouse_melon/tools/spec_steps_report.rb
+- lib/mouse_melon/tools/spec_steps_result.rb
+- lib/mouse_melon/tools/step_definitions_parser.rb
+- lib/mouse_melon/version.rb
+- mouse_melon.gemspec
+homepage: http://github.com/wojtha/mouse_melon
+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.4.8
+signing_key: 
+specification_version: 4
+summary: mouse_melon-0.0.1
+test_files: []
+has_rdoc: