cukedep 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTViZGY3MjYyZjAyOThlODc2YmQ4ODE1M2Y4NGI0N2IzMzliNmU5Yw==
+    YTdmNmY0Y2RkMTQxYjk5NmY2OGU2ZGIzMWVkNWQ0MmQ3MTFjNTk5OA==
   data.tar.gz: !binary |-
-    ZWFkN2Y4YThkZDNiODQ4ZDczMmFkMTBhNTk4OTQ0NTMzNWZmN2FlYg==
+    NjMxMWRiMmZiOWEwYjAwMmFiZWRlYTVlZDczMTU4OThkMjM1MTE2ZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTEzZjdmYmVhNmNhMzU2MWVhMGFhYzhhYmM2NDdlOGNkOTMzNzkwYjBmNGNi
-    YmNkYWE5YzBlZTU4N2Y1OTJiOGI2MGRjNjg3MzMzZGFiYmUxMmRlYTQ4ZWZl
-    YjE0MDViOTc5M2E0ZmQxOGE2NDYzNWM5ODU5YWMwMzdlYjU1NTQ=
+    OTExMGMwMzliMTA0NGU2MGU2NTdhMjNlYWQxYjg1YjJlN2NlMDBmYWZiOWZh
+    Yzc2MGU2M2I0ZjkwOWJjZGFlZGJiMmRhNTgzMWU5N2RiNWQwMmUwN2EzYzUy
+    ODUwOGFlZjlmOWVjYjQ4YzZlMTkzMGUwZTE1OWFlNzY3NDAzMzQ=
   data.tar.gz: !binary |-
-    ZjllNDM1ZDE4NGRmMWQzMGE5ZWUxYzIyMjg4ZGU2NGE1ZTg2ZWRiZWEwN2Nj
-    OTQ2ZGE1MTc1ZDRlNTRmZTgzYjJkZjk1Zjg3MzU2ZjE4Y2MzZmIyNjg0NDYx
-    OWVmMDhhMWEzYzc4YmRjNzgzM2I3YzA5NTlhOTZjNmVhZGY3NzE=
+    YzU1MDgyZjk5ZGM3OGE4NTMxNDMwYTk5MWQyNGRmZDY1MGQwMWIyMTI0YmU0
+    YTkxZWYzMTE0N2I0NDVkYjkzMDJjZjhiOTRlMGNmZDJkZmE2NjQxMDRmNWMw
+    MjM4NGJlZDQ4YmYwZWJkMzhkZDkzOWE5OWY1Mjk0NjI2NDgxNmM=

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.0.8 / 2013-10-31
+* [Fix] After adding a non-ASCII in a sample feature, Gherkin raised an encoding incompatibility error. Fixed
+* [CHANGE] Added a new field 'feature_encoding' in Config object to store the encoding of feature files (default = 'UTF-8')
+* [NEW] Class `GherkinFacade`
+* [CHANGE] `Application#parse_features` method
+
 ### 0.0.7 / 2013-10-25
 * [CHANGE] Method `Application#generate_files` now uses the filenames as specified in the `cukedep.yml` file.
 

data/lib/cukedep/application.rb

@@ -1,11 +1,11 @@
 # File: application.rb
 
 require 'yaml'
-require 'gherkin/parser/parser'
 
 require_relative 'cli/cmd-line'
 require_relative 'config'
 require_relative 'gherkin-listener'
+require_relative 'gherkin-facade'
 require_relative 'feature-model'
 
 module Cukedep # Module used as a namespace
@@ -34,7 +34,7 @@ public
       @proj_dir = config.proj_dir
     end
 
-    feature_files = parse_features
+    feature_files = parse_features(config.feature_encoding)
     
     model = FeatureModel.new(feature_files)
     generate_files(model, config)
@@ -75,23 +75,15 @@ protected
     end
   end
 
-  # Parse the feature files
-  def parse_features()
+  # Parse the feature files (with the specified external encoding)
+  def parse_features(external_encoding)
     # Create a Gherkin listener
     listener = Cukedep::GherkinListener.new
-
-    # Create a Gherkin parser
-    parser = Gherkin::Parser::Parser.new(listener)
-
-    # List all the .feature files
-    filenames = Dir.glob('*.feature')
-    puts "\nParsing:"
     
-    # Parse them
-    filenames.each do |fname|
-      puts "  #{fname}"
-      File.open(fname, 'r') { |f| parser.parse(f.read, fname, 0) }
-    end
+    # Parse the feature files in work directory
+    is_verbose = true
+    gherkin_facade = GherkinFacade.new(is_verbose, external_encoding)
+    gherkin_facade.parse_features(listener, ['*.feature'])
 
     return listener.feature_files
   end

data/lib/cukedep/config.rb

@@ -5,6 +5,7 @@ module Cukedep # Module used as a namespace
 FileMetaData = Struct.new(:name)
 
 Config = Struct.new(
+  :feature_encoding, # The encoding of feature files
   :proj_dir,    # The directory of the cucumber project
   :feature2id,  # Meta-data about the feature => feature id report
   :id2feature,  # Meta-data about the feature id => feature report
@@ -20,6 +21,7 @@ class Config
   # Factory method. Build a config object with default settings.
   def self.default()
     Config.new(
+      'UTF-8',
       nil, 
       FileMetaData.new('feature2id.csv'), 
       FileMetaData.new('feature2id.csv'), 

data/lib/cukedep/constants.rb

@@ -3,7 +3,7 @@
 
 module Cukedep # Module used as a namespace
   # The version number of the gem.
-  Version = '0.0.7'
+  Version = '0.0.8'
 
   # Brief description of the gem.
   Description = 'Manage dependencies between Cucumber feature files'
@@ -11,7 +11,7 @@ module Cukedep # Module used as a namespace
   # Constant Cukedep::RootDir contains the absolute path of Rodent's
   # root directory. Note: it also ends with a slash character.
   unless defined?(RootDir)
-  # The initialisation of constant RootDir is guarded in order 
+  # The initialisation of constant RootDir is guarded in order
   # to avoid multiple initialisation (not allowed for constants)
 
     # The root folder of Cukedep.
@@ -20,7 +20,7 @@ module Cukedep # Module used as a namespace
       rootdir = Pathname(__FILE__).dirname.parent.parent.expand_path
       rootdir.to_s + '/'	# Append trailing slash character to it
     end
-    
+
     # The file name for the user's settings
     YMLFilename = '.cukedep.yml'
   end

data/lib/cukedep/gherkin-facade.rb

@@ -0,0 +1,52 @@
+# File: gherkin-facade.rb
+
+require 'gherkin'
+require 'gherkin/lexer/encoding'
+
+module Cukedep # This module is used as a namespace
+
+  # Facade design pattern: A facade is an object that provides
+  # a simplified interface to a larger body of code.
+  # Here the GherkinFacade class provides basic parsing service.
+  class GherkinFacade
+    # Indicate whether the parsing must be verbose or silent
+    attr_reader(:verbose)
+    
+    # (External) encoding of the feature files.
+    # It is a string that represents the name of an encoding
+    # as expected by the mode argument of the IO#new method
+    attr_reader(:external_encoding)
+    
+
+    def initialize(isVerbose, anExternalEncoding)
+      @verbose = isVerbose
+      @external_encoding = anExternalEncoding
+    end
+    
+    # Parse feature files from the work directory that match
+    # one of the given file name patterns.
+    # Parse events are sent to the passed listener object.
+    def parse_features(aListener, file_patterns)
+      # Create a Gherkin parser
+      parser = Gherkin::Parser::Parser.new(aListener)
+
+      puts "\nParsing:" if verbose
+      # List all .feature files in work directory that match the pattern
+      filenames = []
+      file_patterns.each { |patt| filenames.concat(Dir.glob(patt)) }
+      
+      # Parse them
+      filenames.each do |fname|
+        puts "  #{fname}" if verbose
+        # To prevent encoding issue, open the file with an explicit external encoding
+        File::open(fname, "r:#{external_encoding}") { |f| parser.parse(f.read, fname, 0) }
+      end
+      
+      return aListener
+    end
+  
+  end # class
+
+end # module
+
+# End of file

data/spec/cukedep/file-parsing.rb

@@ -1,6 +1,6 @@
 # File: file-parsing.rb
 
-require 'gherkin/parser/parser'
+require_relative '../../lib/cukedep/gherkin-facade'
 
 module Cukedep # This module is used as a namespace
 
@@ -19,18 +19,21 @@ module Cukedep # This module is used as a namespace
     # Helper method. It parses sample feature files and
     # notifies the provided listener of its progress.
     def parse_for(aListener)
-      # Determine the folder where the sample files reside
-      my_dir = File.dirname(__FILE__)
-      sample_dir = File.expand_path(my_dir + '/sample_features')
-      
-      # Create a Gherkin parser
-      parser = Gherkin::Parser::Parser.new(aListener)
-      
-      # Let it parse the requested files
-      SampleFileNames.each do |sample|
-        path = sample_dir + '/' + sample
-        File::open(path, 'r') { |f| parser.parse(f.read, path, 0) }
+      orig_dir = Dir.getwd()
+      begin
+        # Determine the folder where the sample files reside
+        my_dir = File.dirname(__FILE__)
+        sample_dir = File.expand_path(my_dir + '/sample_features')
+        Dir.chdir(sample_dir)
+        
+        # Parse the specified feature files in work directory
+        is_verbose = false
+        gherkin_facade = GherkinFacade.new(is_verbose, 'UTF-8')
+        gherkin_facade.parse_features(aListener, SampleFileNames)
+      ensure
+        Dir.chdir(orig_dir)
       end
+      
     end
   
   end # module

data/spec/cukedep/sample_features/standalone.feature

@@ -1,3 +1,4 @@
+# § <- This character is UTF-8
 # This feature has no identifier and no explicit dependencies
 Feature: Registering new videos
   As a video rental owner

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cukedep
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-25 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -122,14 +122,11 @@ files:
 - lib/cukedep/constants.rb
 - lib/cukedep/feature-model.rb
 - lib/cukedep/feature-rep.rb
+- lib/cukedep/gherkin-facade.rb
 - lib/cukedep/gherkin-listener.rb
 - sample/features/step_definitions/steps.rb
 - sample/features/support/env.rb
-- sample/model/catalogue.yml
-- sample/model/members.yml
 - sample/model/model.rb
-- sample/model/rentals.yml
-- sample/model/users.yml
 - spec/cukedep/application_spec.rb
 - spec/cukedep/cli/cmd-line_spec.rb
 - spec/cukedep/feature-model_spec.rb
@@ -138,10 +135,6 @@ files:
 - spec/cukedep/gherkin-listener_spec.rb
 - spec/spec_helper.rb
 - spec/cukedep/sample_features/a_few_tests.feature
-- spec/cukedep/sample_features/cukedep.rake
-- spec/cukedep/sample_features/dependencies.dot
-- spec/cukedep/sample_features/feature2id.csv
-- spec/cukedep/sample_features/id2feature.csv
 - spec/cukedep/sample_features/more_tests.feature
 - spec/cukedep/sample_features/other_tests.feature
 - spec/cukedep/sample_features/some_tests.feature

data/sample/model/catalogue.yml

@@ -1,13 +0,0 @@
----
-- !ruby/struct:Sample::Video
-  title: The empire of Cucumber
-  state: :available
-- !ruby/struct:Sample::Video
-  title: The revenge of the Cucumber
-  state: :available
-- !ruby/struct:Sample::Video
-  title: The peeled Cucumber
-  state: :available
-- !ruby/struct:Sample::Video
-  title: The masked Cucumber
-  state: :available

data/sample/model/members.yml

@@ -1,13 +0,0 @@
----
-- !ruby/struct:Sample::Member
-  name: John Doe
-- !ruby/struct:Sample::Member
-  name: Jed Eye
-- !ruby/struct:Sample::Member
-  name: Bill Bo
-- !ruby/struct:Sample::Member
-  name: Jack Orjones
-- !ruby/struct:Sample::Member
-  name: Mary Gherkin
-- !ruby/struct:Sample::Member
-  name: Waldo Cuke

data/sample/model/rentals.yml

@@ -1,4 +0,0 @@
----
-- !ruby/struct:Sample::Rental
-  video: The masked Cucumber
-  member: John Doe

data/sample/model/users.yml

@@ -1,7 +0,0 @@
----
-- !ruby/struct:Sample::User
-  credential: it's me
-- !ruby/struct:Sample::User
-  credential: himself
-- !ruby/struct:Sample::User
-  credential: nemo

data/spec/cukedep/sample_features/cukedep.rake

@@ -1,191 +0,0 @@
-# File: cukedep.rake
-# Generated by Cukedep 0.0.6 on 25/10/2013 21:52:06
-
-require 'rake'
-
-# Run Cucumber via specialized Rake task
-require 'cucumber/rake/task'
-# UGLY workaround for bug in Cucumber's rake task
-if Gem::VERSION[0].to_i >= 2 && Cucumber::VERSION <= '1.3.2'
-  # Monkey-patch a buggy method
-  class Cucumber::Rake::Task::ForkedCucumberRunner
-    def gem_available?(gemname)
-      if Gem::VERSION[0].to_i >= 2 
-        gem_available_new_rubygems?(gemname)
-      else
-        gem_available_old_rubygems?(gemname)
-      end
-    end  
-  end # class
-end
-
-# Create a task called cucumber
-Cucumber::Rake::Task.new do |t|
-end
-
-
-# Constant holding the location of the original feature files
-SOURCE_DIR = 'C:/Ruby193/lib/ruby/site_ruby/Cukedep/spec/cukedep/sample_features'
-
-# Constant holding the location of the project
-CUKE_PROJECT = 'C:/Ruby193/lib/ruby/site_ruby/Cukedep/sample'
-
-# Helper method. Calculate the filepath of a file with given name
-# if it is located in the source dir.
-def source_path_of(aFilename)
-  SOURCE_DIR + '/' + aFilename
-end
-
-# Helper method. Calculate the filepath of a file with given name
-# if it is located in the project featurers dir.
-def project_path_of(aFilename)
-  CUKE_PROJECT + '/features/' + aFilename
-end
-
-# Helper method. Given the name of files in the source dir, copy them 
-# into the project dir.
-def copy_to_project(filenames)
-  filenames.each do |fname|
-    source_path = source_path_of(fname)
-    dest_path = project_path_of(fname)
-    FileUtils.copy_file(source_path, dest_path)
-  end
-end
-
-
-# Helper method. Given the name of files in the features dir of the project, 
-# copy them into the source dir.
-def copy_from_project(*filenames)
-  filenames.each do |fname|
-    source_path =  project_path_of(fname)
-    dest_path = source_path_of(fname)
-    FileUtils.copy_file(source_path, dest_path)
-  end
-end
-
-def del_from_project(filenames)
-  filenames.each do |fname|
-    dest_path = project_path_of(fname)
-    FileUtils.remove_file(dest_path)
-  end
-end
-
-# Helper method. Delete all the files in the 
-# the project's features dir that match one of 
-# the file name pattern
-def clean_project_dir(fname_patterns)
-  curr_dir = Dir.getwd()
-  begin
-    Dir.chdir(CUKE_PROJECT + '/features')
-    fname_patterns.each do |patt|
-      filenames = Dir.glob(patt)
-      filenames.each { |fn| FileUtils.remove_file(fn) }
-    end
-  ensure  #Always restore previous working dir.
-    Dir.chdir(curr_dir)
-  end
-end
-
-
-def process_files(filenames)
-  copy_to_project(filenames)
-  curr_dir = Dir.getwd()
-  Dir.chdir(CUKE_PROJECT)
-  begin
-    do_cuke = Rake::Task[:cucumber]
-    do_cuke.reenable
-    do_cuke.invoke
-  ensure
-    Dir.chdir(curr_dir)
-  end
-  del_from_project(filenames)
-end
-
-def process_a_feature(filename)
-  process_files([filename])
-end
-
-
-AllUnidentifiedFeatures = [
-  'standalone.feature'
-]
-  
-
-AllFeatureIdentifiers = [ 
-  :qux,
-  :quux,
-  :corge,
-  :foo,
-  :baz,
-  :bar
-]
-
-# Default rake task is also top-level task
-task :default => :run_all_features
-
-
-desc 'Run all features'
-task :run_all_features => [:before_all, :all_features, :after_all] do
-  ; # Do nothing
-end
-
-
-# Remove feature files from a cuke project
-task :dir_cleanup do
-  clean_project_dir(['*.feature'])
-end
-
-
-
-desc 'Before all' 
-task :before_all => [:dir_cleanup] do
-  ; # Do nothing
-end
-
-desc 'After_all'
-task :after_all do
-  ; # Do nothing
-end
-
-
-task :unidentified do
-  process_files(AllUnidentifiedFeatures)
-end
-
-# Tasks for feature files involved in dependencies
-
-
-task :qux  do
-  process_a_feature('a_few_tests.feature')
-end
-
-
-task :quux  do
-  process_a_feature('more_tests.feature')
-end
-
-
-task :corge => [:foo] do
-  process_a_feature('other_tests.feature')
-end
-
-
-task :foo => [:bar, :qux] do
-  process_a_feature('some_tests.feature')
-end
-
-
-task :baz  do
-  process_a_feature('still_other_tests.feature')
-end
-
-
-task :bar => [:baz, :qux, :quux] do
-  process_a_feature('yet_other_tests.feature')
-end
-
-
-task :all_features => ([:unidentified] + AllFeatureIdentifiers) do
-end
-
-# End of file

data/spec/cukedep/sample_features/dependencies.dot

@@ -1,38 +0,0 @@
-// Graph of dependencies of feature files in directory:
-// 'C:/Ruby193/lib/ruby/site_ruby/Cukedep/spec/cukedep/sample_features'
-// This file uses the DOT syntax, a free utility from the Graphviz toolset.
-// Graphviz is available at: www.graphviz.org
-// File generated on Fri Oct 25 21:52:06 2013.
-
-digraph g {
-  size = "7, 11"; // Dimensions in inches...
-  center = true;  
-  rankdir = BT; // Draw from bottom to top
-  label = "\nDependency graph of 'C:/Ruby193/lib/ruby/site_ruby/Cukedep/spec/cukedep/sample_features'";  
-  
-  // Nodes represent feature files
-  subgraph island {
-    node [shape = box, style=filled, color=lightgray];
-    node_4 [label = "standalone"];
-    label = "Isolated features";
-    }
-
-  subgraph dependencies {
-    node [shape = box, fillcolor = none];
-    node_0 [label = "a_few_tests -- qux"];
-    node_1 [label = "more_tests -- quux"];
-    node_2 [label = "other_tests -- corge"];
-    node_3 [label = "some_tests -- foo"];
-    node_5 [label = "still_other_tests -- baz"];
-    node_6 [label = "yet_other_tests -- bar"];
-    label = "Dependencies";
-  }
-
-  // The edges represent dependencies
-	node_2 -> node_3;
-	node_3 -> node_6;
-	node_3 -> node_0;
-	node_6 -> node_5;
-	node_6 -> node_0;
-	node_6 -> node_1;
-} // End of graph

data/spec/cukedep/sample_features/feature2id.csv

@@ -1,7 +0,0 @@
-identifier,feature file
-qux,a_few_tests.feature
-quux,more_tests.feature
-corge,other_tests.feature
-foo,some_tests.feature
-baz,still_other_tests.feature
-bar,yet_other_tests.feature

data/spec/cukedep/sample_features/id2feature.csv

@@ -1,7 +0,0 @@
-identifier,feature file
-qux,a_few_tests.feature
-quux,more_tests.feature
-corge,other_tests.feature
-foo,some_tests.feature
-baz,still_other_tests.feature
-bar,yet_other_tests.feature