crabfarm 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 561ccdb4b56beae4a09b06ef5d9c492b8e888af3
-  data.tar.gz: d82a80deee23886c46cc0a32e548b0fe6adafd84
+  metadata.gz: 52ca9c7f98addbe26b5ff98ae502c9f0526d78dd
+  data.tar.gz: 8460bde2927f16b4bfb0231724b09d17da0b24dc
 SHA512:
-  metadata.gz: 4dc9440b50e5b98c8ab7aebb0f66312bb50e6cae1a5664a195c1c3c3a2bb7d96d441874650dae2b3aa42bf0860fcdc520ed41f74b4461cbce9a5b1989447b227
-  data.tar.gz: d44adc9a73de3f67088746b4ad9686245f7d0726ffe1ca67ee2f526f5f6ff7b1b9caad22c84ffc59510892fe5f4e7a087314af281f677569e277c50493ca54d7
+  metadata.gz: 566ec3a924a621d53bb91b59628bf269de1794455800d7eabf9632076c970d44bd56c60a09fb0518e6aed8f7cf5a94eb4dd7cffc284da0fa4956808b8129fdcd
+  data.tar.gz: a52684de47189cb632e3a35cab4fd76980bc1e2021428c12344241fd266eef7984de92bcb6a1069f1422e66c6580f2cb5cd8a992ef9ae61aec600fb783687529

data/lib/crabfarm.rb

@@ -23,6 +23,7 @@ require "crabfarm/base_parser"
 require "crabfarm/strategies"
 
 require "crabfarm/utils/port_discovery"
+require "crabfarm/utils/naming"
 
 module Crabfarm
 

data/lib/crabfarm/base_state.rb

@@ -29,6 +29,7 @@ module Crabfarm
 
       @dsl = Strategies.load(:browser_dsl, class_browser_dsl || Crabfarm.config.browser_dsl)
       @builder = Strategies.load(:output_builder, class_output_builder || Crabfarm.config.output_builder)
+      @output = @builder.prepare
     end
 
     def browser(_name=nil)
@@ -40,7 +41,7 @@ module Crabfarm
     end
 
     def output
-      @output ||= @builder.prepare
+      @output
     end
 
     def output_as_json

data/lib/crabfarm/cli.rb

@@ -16,7 +16,7 @@ module Crabfarm
       Support::GLI.generate_options c
 
       c.action do |global_options,options,args|
-        next puts "This command can only be run inside a crabfarm application" unless GlobalState.inside_crawler_app?
+        next puts "This command can only be ran inside a crabfarm application" unless GlobalState.inside_crawler_app?
 
         Crabfarm.config.set Support::GLI.parse_options options
 
@@ -50,7 +50,7 @@ module Crabfarm
       Support::GLI.generate_options c
 
       c.action do |global_options,options,args|
-        next puts "This command can only be run inside a crabfarm application" unless GlobalState.inside_crawler_app?
+        next puts "This command can only be ran inside a crabfarm application" unless GlobalState.inside_crawler_app?
 
         Crabfarm.config.set Support::GLI.parse_options options
 
@@ -78,7 +78,7 @@ module Crabfarm
         app.flag [:r, :remote]
 
         app.action do |global_options,options,args|
-          next puts "This command cannot be run inside a crabfarm application" if GlobalState.inside_crawler_app?
+          next puts "This command cannot be ran inside a crabfarm application" if GlobalState.inside_crawler_app?
 
           require "crabfarm/modes/generator"
           Crabfarm::Modes::Generator.generate_app(Dir.pwd, args[0], options[:remote])
@@ -88,7 +88,7 @@ module Crabfarm
       c.desc "Generates a new crabfarm parser and parser spec"
       c.command :parser do |parser|
         parser.action do |global_options,options,args|
-          next puts "This command can only be run inside a crabfarm application" unless GlobalState.inside_crawler_app?
+          next puts "This command can only be ran inside a crabfarm application" unless GlobalState.inside_crawler_app?
 
           require "crabfarm/modes/generator"
           Crabfarm::Modes::Generator.generate_parser(GlobalState.app_path, args[0])
@@ -98,7 +98,7 @@ module Crabfarm
       c.desc "Generates a new crabfarm state and parser spec"
       c.command :state do |parser|
         parser.action do |global_options,options,args|
-          next puts "This command can only be run inside a crabfarm application" unless GlobalState.inside_crawler_app?
+          next puts "This command can only be ran inside a crabfarm application" unless GlobalState.inside_crawler_app?
 
           require "crabfarm/modes/generator"
           Crabfarm::Modes::Generator.generate_state(GlobalState.app_path, args[0])
@@ -106,13 +106,13 @@ module Crabfarm
       end
     end
 
-    desc "Perform an HTTP recording for use in tests"
+    desc "Perform a memento recording for use in tests"
     command [:record, :r] do |c|
       c.desc "Run recorder in playback mode"
       c.switch [:p, :playback], :default_value => false
 
       c.action do |global_options, options, args|
-        next puts "This command can only be run inside a crabfarm application" unless GlobalState.inside_crawler_app?
+        next puts "This command can only be ran inside a crabfarm application" unless GlobalState.inside_crawler_app?
 
         require "crabfarm/modes/recorder"
         Crabfarm::Modes::Recorder.start GlobalState.memento_path(args[0]), options[:playback]
@@ -128,7 +128,7 @@ module Crabfarm
       c.switch :unsafe, :default_value => false
 
       c.action do |global_options,options,args|
-        next puts "This command can only be run inside a crabfarm application" unless GlobalState.inside_crawler_app?
+        next puts "This command can only be ran inside a crabfarm application" unless GlobalState.inside_crawler_app?
 
         options[:remote] = args[0]
 

data/lib/crabfarm/global_state.rb

@@ -10,11 +10,13 @@ module Crabfarm
     end
 
     def memento_path(_name)
+      return nil if _name.nil?
       File.join(app_path, 'spec/mementos', _name + '.json.gz')
     end
 
-    def snapshot_path(_file)
-      File.join(app_path, 'spec/snapshots', _file)
+    def snapshot_path(_file_name)
+      return nil if _file_name.nil?
+      File.join(app_path, 'spec/snapshots', _file_name)
     end
 
     extend self

data/lib/crabfarm/modes/console.rb

@@ -59,7 +59,8 @@ module Crabfarm
           rescue SystemExit, Interrupt
             break
           rescue => e
-            puts "Unknown command".color(:red)
+            puts "#{e.to_s}".color(:red)
+            puts e.backtrace
           end
         end
 

data/lib/crabfarm/modes/generator.rb

@@ -35,21 +35,26 @@ module Crabfarm
         end
       end
 
-      def generate_state(_target, _name)
-        class_name = _name.camelize
+      def generate_state(_target, _class_name)
+        validate_class_name _class_name
+
+        route = Utils::Naming.route_from_constant _class_name
         with_base_path _target do
-          binding = { state_class: class_name.camelize }
-          path('app', 'states', class_name.underscore + '.rb').render('state.rb', binding)
-          path('spec', 'states', class_name.underscore + '_spec.rb').render('state_spec.rb', binding)
+          binding = { state_class: _class_name }
+          path(*(['app', 'states'] + route[0...-1] + [route.last + '.rb'])).render('state.rb', binding)
+          path(*(['spec', 'states'] + route[0...-1] + [route.last + '_spec.rb'])).render('state_spec.rb', binding)
         end
       end
 
-      def generate_parser(_target, _name)
-        class_name = _name.camelize + 'Parser'
+      def generate_parser(_target, _class_name)
+        validate_class_name _class_name
+
+        _class_name = _class_name + 'Parser'
+        route = Utils::Naming.route_from_constant _class_name
         with_base_path _target do
-          binding = { parser_class: class_name }
-          path('app', 'parsers', class_name.underscore + '.rb').render('parser.rb', binding)
-          path('spec', 'parsers', class_name.underscore + '_spec.rb').render('parser_spec.rb', binding)
+          binding = { parser_class: _class_name }
+          path(*(['app', 'parsers'] + route[0...-1] + [route.last + '.rb'])).render('parser.rb', binding)
+          path(*(['spec', 'parsers'] + route[0...-1] + [route.last + '_spec.rb'])).render('parser_spec.rb', binding)
         end
       end
 
@@ -116,6 +121,10 @@ module Crabfarm
         puts _op.rjust(10).color(_color) + '  ' + _message
       end
 
+      def validate_class_name(_name)
+        raise Crabfarm::ArgumentError.new "Invalid class name '#{_name}'" unless Utils::Naming.is_constant_name? _name
+      end
+
       extend self
     end
   end

data/lib/crabfarm/modes/recorder.rb

@@ -26,7 +26,7 @@ module Crabfarm
           driver = DefaultDriverFactory.new(driver_config).build_driver nil
 
           begin
-            puts "Press Ctrl-C to stop capturing."
+            puts "Press Ctrl-C or close browser to stop #{_replay ? 'playback' : 'capturing'}."
             loop do
               driver.current_url
               sleep 1.0

data/lib/crabfarm/transition_service.rb

@@ -3,7 +3,7 @@ module Crabfarm
 
     def self.apply_state(_context, _name, _params={})
       state_class = if _name.is_a? String or _name.is_a? Symbol
-        load_by_name _name
+        load_class_from_uri _name
       else _name end
 
       _context.prepare
@@ -14,9 +14,9 @@ module Crabfarm
 
   private
 
-    def self.load_by_name(_name)
-      name = _name.to_s.gsub(/[^A-Z0-9:]+/i, '_').camelize
-      name.constantize
+    def self.load_class_from_uri(_uri)
+      class_name = Utils::Naming.decode_crabfarm_uri _uri
+      class_name.constantize
     end
 
   end

data/lib/crabfarm/utils/naming.rb

@@ -0,0 +1,19 @@
+module Crabfarm
+  module Utils
+    module Naming
+
+      def self.is_constant_name?(_name)
+        /^([A-Z][A-Za-z0-9]*)(\:\:[A-Z][A-Za-z0-9]*)*$/ === _name
+      end
+
+      def self.route_from_constant(_class_name)
+        _class_name.split('::').map(&:underscore)
+      end
+
+      def self.decode_crabfarm_uri(_uri)
+        _uri.to_s.split('/').map { |p| p.gsub(/[^A-Z0-9:]+/i, '_').camelize }.join('::')
+      end
+
+    end
+  end
+end

data/lib/crabfarm/version.rb

@@ -1,3 +1,3 @@
 module Crabfarm
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crabfarm
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ignacio Baixas
@@ -433,6 +433,7 @@ files:
 - lib/crabfarm/templates/state.rb.erb
 - lib/crabfarm/templates/state_spec.rb.erb
 - lib/crabfarm/transition_service.rb
+- lib/crabfarm/utils/naming.rb
 - lib/crabfarm/utils/port_discovery.rb
 - lib/crabfarm/utils/processes.rb
 - lib/crabfarm/version.rb