gherkin3_reformat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 729547e698b28b14aac4ed057af2e803eab98353
+  data.tar.gz: 80a9d16ae0bb38fa876ed141377934a25f5819c2
+SHA512:
+  metadata.gz: ff6e7a64c2cec9e80072d8a48ca987c7a19c361b5f9fb5d27389c8e7de47299216c1b65c958555a8fbfa332f06bda2751d633ed9d4cc8a7eb21a0287f2da8640
+  data.tar.gz: 9a1f732380078608dbf0900f24900d6a9cc8fde8557779b164d7ebf2ae3a94fb8932189d7d5495f02b207247730aa75268163c70d7d9d320028ff6607ffb9775

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 James Pickering
+
+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,42 @@
+# Gherkin3Reformat
+
+A script to reformat Gherkin3 code, to a consistent style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gherkin3_reformat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gherkin3_reformat
+
+## Usage
+
+```bash
+gherkin3_reformat features/myfeature.feature > features/myfeature_reformatted.feature
+gherkin3_reformat --replace features/*.feature
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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]/gherkin3_reformat.
+
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gherkin3_reformat"
+
+# 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/gherkin3_reformat

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'gherkin3_reformat'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: gherkin3_reformat [options] filenames"
+
+  opts.on("-r", "--[no-]replace", "Replace original files") do |r|
+    options[:replace] = r
+  end
+end.parse!
+
+ARGV.each do |filename|
+  begin
+    output = Gherkin3Reformat.format_file(filename)
+    if options[:replace] then
+      File.write(filename, output)
+    else
+      puts output
+    end
+  rescue => e
+    STDERR.puts "Error formatting #{filename}: #{e}"
+    STDERR.puts e.backtrace.join("\n")
+  end
+end

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/gherkin3_reformat.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gherkin3_reformat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gherkin3_reformat"
+  spec.version       = Gherkin3Reformat::VERSION
+  spec.authors       = ["James Pickering"]
+  spec.email         = ["james_pic@hotmail.com"]
+
+  spec.summary       = %q{Tool to reformat Gherkin3 files}
+  spec.description   = %q{Tool to reformat Gherkin3 files to a consistent style}
+  spec.homepage      = "http://github.com/jamespic/gherkin3_reformat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
+  spec.bindir        = "bin"
+  spec.executables   = ['gherkin3_reformat']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_dependency "gherkin3", "~> 3.1.2"
+end

data/lib/gherkin3_reformat.rb

@@ -0,0 +1,139 @@
+require "gherkin3_reformat/version"
+
+require 'gherkin3/parser'
+
+module Gherkin3Reformat
+  def self.format(feature)
+    items = []
+    items.push(feature)
+    feature[:comments].each {|comment| items.push(comment)}
+    items.push(feature[:background]) if feature.has_key?(:background)
+    feature[:scenarioDefinitions].each do |scenario|
+      items.push(scenario)
+      if scenario.has_key?(:examples) then 
+        scenario[:examples].each do |example|
+          items.push(example)
+          table = [example[:tableHeader]] + example[:tableBody]
+          items.concat(self.handle_table(table, 4))
+          
+        end
+      end
+      scenario[:tags].each{|tag| items.push(tag)}
+      scenario[:steps].each do |step|
+        if step.has_key?(:argument) then
+          argument = step[:argument]
+          case argument[:type]
+          when :DataTable
+            items.concat(self.handle_table(argument[:rows], 6))
+          when :DocString
+            items.push(argument)
+          end
+        end
+        items.push(step)
+      end
+    end
+    
+    items.sort! do |a, b|
+      linecomp = a[:location][:line] <=> b[:location][:line]
+      linecomp != 0 ? linecomp : a[:location][:column] <=> b[:location][:column]
+    end
+    
+    self.calculate_comment_indents_and_add_newlines_before_scenarios(items)
+    
+    items.map {|item| self.pretty_print(item)}.join('')
+  end
+  
+  def self.format_string(data)
+    parser = Gherkin3::Parser.new
+    self.format(parser.parse(data))
+  end
+  
+  def self.format_file(filename)
+    parser = Gherkin3::Parser.new
+    File.open(filename) do |file|
+      self.format(parser.parse(file))
+    end
+  end
+  
+  private
+  
+    def self.pretty_print(node)
+      formatted = case node[:type]
+      when :Feature
+        self.pretty_print_node_with_blurb_and_indent(node, 0)
+      when :Background, :Scenario, :ScenarioOutline, :Examples
+        self.pretty_print_node_with_blurb_and_indent(node, 2)
+      when :Step
+        "#{' ' * 4}#{node[:keyword]}#{node[:text]}\n"
+      when 'TableRow'
+        "#{' ' * node[:indent]}| #{node[:cells].map{|cell| cell[:value].ljust(cell[:maxWidth], ' ')}.join(' | ')} |\n"
+      when :DocString
+        self.pretty_print_docstring(node)
+      when 'Comment'
+        "#{' ' * node[:indent]}#{node[:text].strip}\n"
+      end
+      if node[:precedingNewline] then "\n#{formatted}" else formatted end
+    end
+    
+    def self.pretty_print_node_with_blurb_and_indent(node, indent)
+      tags = node[:tags].any? ? "#{' ' * indent}#{node[:tags].map {|tag| tag[:name]}.join(' ')}\n" : ''
+      first_row = "#{' ' * indent}#{node[:keyword]}: #{node[:name].strip}".rstrip
+      description = node.has_key?(:description) ? node[:description].split("\n").map {|row| (' ' * (indent + 2)) + row.strip}.join("\n") + "\n" : ''
+      "#{tags}#{first_row}\n#{description}"
+    end
+    
+    def self.handle_table(table, indent)
+      widths = table.map{
+        |row| row[:cells].map{|cell| cell[:value].size}
+      }.reduce{
+        |row1, row2| row1.zip(row2).map(&:max)
+      }
+      table.map do |row|
+        row[:cells].zip(widths).each do |cell, width|
+          cell[:maxWidth] = width
+        end
+        row[:indent] = indent
+        row
+      end
+    end
+    
+    def self.pretty_print_docstring(docstring)
+      %Q{#{' ' * 6}"""#{docstring[:contentType]}\n#{' ' * 6}#{docstring[:content].gsub("\n", "\n#{' ' * 6}")}\n#{' ' * 6}"""\n}
+    end
+    
+    def self.calculate_comment_indents_and_add_newlines_before_scenarios(items)
+      target_for_preceding_newline = nil
+      indent = 0
+      attach_any_newlines = lambda do
+        target_for_preceding_newline[:precedingNewline] = true if target_for_preceding_newline
+        target_for_preceding_newline = nil
+      end
+      items.reverse.each do |item|
+        case item[:type]
+        when :Feature
+          attach_any_newlines.call
+          indent = 0
+        when :Background, :Scenario, :ScenarioOutline
+          attach_any_newlines.call
+          indent = 2
+          target_for_preceding_newline = item
+        when :Step
+          attach_any_newlines.call
+          indent = 4
+        when :Examples
+          attach_any_newlines.call
+          indent = 2
+        when 'TableRow'
+          attach_any_newlines.call
+          indent = item[:indent]
+        when :DocString
+          attach_any_newlines.call
+          indent = 6
+        when 'Comment'
+          target_for_preceding_newline = item if target_for_preceding_newline
+          item[:indent] = indent
+        end
+      end
+      attach_any_newlines.call
+    end
+end

data/lib/gherkin3_reformat/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: gherkin3_reformat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Pickering
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-10 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: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: gherkin3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+description: Tool to reformat Gherkin3 files to a consistent style
+email:
+- james_pic@hotmail.com
+executables:
+- gherkin3_reformat
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gherkin3_reformat
+- bin/setup
+- gherkin3_reformat.gemspec
+- lib/gherkin3_reformat.rb
+- lib/gherkin3_reformat/version.rb
+homepage: http://github.com/jamespic/gherkin3_reformat
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Tool to reformat Gherkin3 files
+test_files: []