conformity 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d8642508831e87cddb514c49e41a861c72e0763
-  data.tar.gz: 49f1b297869149c45f33b30eeb9a10988269ab8d
+  metadata.gz: 01f3786cd9944fbc1a8275c48afcc2dc9128ea83
+  data.tar.gz: f0d8722c3d724f21c3bb712e34057911a7bd6f3a
 SHA512:
-  metadata.gz: 04448922009d3e0e41f6d1b49502ab18b34d1b492f8d5efa21b3220e12001e164990a41904970df2b8dfb9407a43357cac744e1332ef44c2a6f6baf0854287c5
-  data.tar.gz: f091d83d17f1206ca70f061b6b40eb88110bb2b27938e2375ff794af52f154f50a38a57b3b93efe1b428aafe43428d62ba37c1ce9213d88bac342f1a9221c9be
+  metadata.gz: 0ec8f708b330e8cb8d75d8e856f9f1b766e97cb2780cf73458c639a577153a299e9a75f7b153098e92a86ee90dbdd58debee712e3ad55e143a31d7add4354a13
+  data.tar.gz: 643358251d8989f885d6cd189d0ad5fda13402fd3f548420a4bfedb3c17ab2dd66dd24d1b30bf9452f2cf431e013e4379297c5aefc398891df9e886533232396

data/lib/conformity/actions.rb

@@ -0,0 +1,38 @@
+module Conformity
+  class Actions
+    attr_reader :session
+
+    ACTIONS = [:visit, :find, :fill_in, :select, :check, :uncheck, :choose,
+               :click_on, :wait]
+
+    def initialize(session = Capybara.current_session)
+      @session = session
+    end
+
+    def field(name, options={})
+      Field.value(name)
+    end
+
+    def method_missing(name, *args, &block)
+      if ACTIONS.include?(name)
+        session.send(name, *args, &block)
+        screenshot(name) if Conformity.log_screenshots
+
+      # ignore SuccessConditions
+      elsif [:has_status_code?, :has_content?]
+      else super
+      end
+    end
+
+    # so Kernel#select isn't called
+    def select(*args, &block)
+      session.send(:select, *args, &block)
+    end
+
+    def screenshot(name)
+      file_name = "#{Time.now.to_i}_#{name}.png"
+      full_path = Conformity.screenshots_folder + "/" + file_name
+      session.send(:save_screenshot, full_path)
+    end
+  end
+end

data/lib/conformity/field.rb

@@ -1,13 +1,31 @@
 module Conformity
   class Field
-    attr_reader :name
-    attr_writer :value
+    attr_reader :name, :options
     attr_accessor :type
 
+    class << self
+      def find(name)
+        fields[name]
+      end
+      
+      def value(name)
+        find(name).value
+      end
+
+      def fields
+        @fields ||= {}
+      end
+
+      def add_field(field)
+        fields[field.name] = field
+      end
+    end
+
     def initialize(name, options = {})
       @name = name
       @options = options[:options]
       @required = options[:required] || false
+      self.class.add_field(self)
     end
 
     def required?
@@ -21,5 +39,13 @@ module Conformity
         raise FieldError, "Required field '#{name}' not set"
       end
     end
+
+    def value=(value)
+      if @options && !@options.include?(value)
+        raise FieldError, "#{value} not in #{@options}"
+      end
+
+      @value = value
+    end
   end
 end

data/lib/conformity/form.rb

@@ -2,8 +2,7 @@ module Conformity
   class Form
     extend Forwardable
 
-    METHODS = [:visit, :find, :fill_in, :select, :check, :uncheck, :choose,
-               :click_on, :wait]
+    attr_reader :actions, :block, :success_conditions
 
     def_delegators :@success_conditions, :has_content?, :has_status_code?,
       :success?
@@ -11,7 +10,9 @@ module Conformity
     def initialize(host = '', &block)
       set_host(host)
       @success_conditions = SuccessConditions.new(Capybara.current_session)
-      instance_eval(&block) if block
+      @actions = Actions.new
+      @block = block
+      instance_eval(&block)
     end
 
     def set_host(host)
@@ -35,7 +36,7 @@ module Conformity
       Capybara.current_session.reset!
 
       begin
-        actions.each(&:run)
+        actions.instance_eval(&block)
       rescue => e
         raise FillError, "#{e.message}"
       end
@@ -49,29 +50,12 @@ module Conformity
     end
 
     def method_missing(name, *args, &block)
-      if METHODS.include?(name)
-        action = Action.new(name, args, block)
-
-        case action.name
-        when :fill_in then action.field.type = :text
-        when :choose  then action.field.type = :radio
-        when :select  then action.field.type = :select
-        end
-
-        actions << action
-      else
-        super
-      end
-    end
-
-    # When passing a block to iniatialize using instance_eval the Kernel#select
-    # method gets called instead of method_missing
-    def select(*args, &block)
-      method_missing(:select, *args, &block)
+      # ignore actions
+      super unless Actions::ACTIONS.include?(name)
     end
 
-    def actions
-      @actions ||= []
+    # so Kernel#select isn't called
+    def select(*args)
     end
   end
 end

data/lib/conformity/version.rb

@@ -1,3 +1,3 @@
 module Conformity
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/conformity.rb

@@ -8,7 +8,7 @@ rescue Gem::LoadError
   poltergeist = false
 end
 
-require 'conformity/action'
+require 'conformity/actions'
 require 'conformity/form'
 require 'conformity/field'
 require 'conformity/success_conditions'
@@ -18,6 +18,19 @@ module Conformity
   class ActionError < ConformityError; end
   class FieldError < ConformityError; end
   class FillError < ConformityError; end
+
+  class << self
+    attr_writer :log_screenshots
+    attr_accessor :screenshots_folder
+
+    def configure
+      yield self
+    end
+
+    def log_screenshots
+      @log_screenshots ||= false
+    end
+  end
 end
 
 Capybara.configure do |config|

data/spec/actions_spec.rb

@@ -0,0 +1,74 @@
+require_relative 'spec_helper'
+require 'capybara'
+require 'conformity/actions'
+
+
+include Conformity
+describe Conformity::Actions do
+  before :each do
+    @field = double('field', value: 'quack')
+  end
+
+  describe "#field" do
+    it "get's the value of the field" do
+      actions = Actions.new
+
+      allow(Field).to receive(:value).with(:name) { "Jane Doe" }
+
+      expect(actions.field(:name)).to match("Jane Doe")
+    end
+  end
+
+  describe "#method_missing" do
+    it "delegates action calls to session" do
+      session = double
+      actions = Actions.new(session)
+
+      expect(session).to receive(:visit).with("/")
+      actions.visit('/')
+    end
+
+    it "ignores success conditions" do
+      session = double
+      actions = Actions.new(session)
+
+      expect { actions.has_status_code?; actions.has_content? }.to_not raise_error
+    end
+  end
+
+  describe "#select" do
+    it "is called on session" do
+      session = double
+      actions = Actions.new(session)
+
+      expect(session).to receive(:select)
+      actions.select('Yes')
+    end
+    
+    it "is not called on Kernel" do
+      skip "not sure how to test"
+      session = double
+      actions = Actions.new(session)
+
+      expect(Kernel).to_not receive(:select)
+      actions.select('Yes')
+    end
+  end
+
+  describe "logging" do
+    it "calls session to save a screenshot" do
+      session = double
+      Conformity.configure do |c|
+        c.log_screenshots = true
+        c.screenshots_folder = "."
+      end
+
+      allow(Time).to receive(:now) { 0 }
+      allow(session).to receive(:visit)
+      expect(session).to receive(:save_screenshot).with("./0_visit.png")
+
+      actions = Actions.new(session)
+      actions.visit('/')
+    end
+  end
+end

data/spec/field_spec.rb

@@ -26,6 +26,19 @@ describe Conformity::Field do
     end
   end
 
+  describe "#value=" do
+    it "sets the value" do
+      field = Field.new(:boolean, options: ["true", "false"])
+      field.value = "true"
+      expect(field.value).to match("true")
+    end
+
+    it "if options are given it raises an error when trying to set a value not in options" do
+      field = Field.new(:field, options: ["one", "two", "three"])
+      expect { field.value = "four" }.to raise_error(Conformity::FieldError)
+    end
+  end
+
   describe "#required?" do
     it "returns true if a field is required" do
       field = Field.new(:field, required: true)
@@ -37,4 +50,23 @@ describe Conformity::Field do
       expect(field.required?).to be_falsey
     end
   end
+
+  describe ".find" do
+    it "returns a field with the given name" do
+      to_find = Field.new(:a)
+      Field.new(:b)
+      Field.new(:c)
+
+      expect(Field.find(:a)).to be(to_find)
+    end
+  end
+
+  describe ".value" do
+    it "returns the value for a field with name" do
+      field = Field.new(:field)
+      field.value = "blue"
+      
+      expect(Field.value(:field)).to match("blue")
+    end
+  end
 end

data/spec/form_spec.rb

@@ -1,14 +1,15 @@
 require_relative 'spec_helper'
 require 'conformity/form'
+require 'pry'
 
 
-describe Conformity::Form do
-  before :each do
-    @form = Form.new
-  end
-
+include Conformity
+describe Form do
+    before :each do
+      @form = Form.new { } # no actions for test
+    end
   describe '#initialize' do
-    it 'can initialize with a block' do
+    it "initializes with a block" do
       expect do
         Form.new do
           visit '/page'
@@ -22,6 +23,10 @@ describe Conformity::Form do
         end
       end.to_not raise_error
     end
+
+    it "raises an error when not given a block" do
+      expect { Form.new }.to raise_error
+    end
   end
 
   describe '#field' do
@@ -56,8 +61,8 @@ describe Conformity::Form do
   end
 
   describe '#fill' do
-    it 'runs the actions' do
-      skip "didn't write test yet!"
+    it "delegates to actions" do
+      skip "test not implemented"
     end
 
     it 'raises FillError on failure' do
@@ -70,35 +75,9 @@ describe Conformity::Form do
     end
   end
 
-  describe '#method_missing' do
-    it 'does not execute actions immediately' do
-      @form.fill_in "#some_id", with: @form.field(:name)
-      expect(Capybara::DSL).to_not receive(:fill_in)
-    end
-
-    describe 'field types' do
-      it 'sets the field type for fill_in' do
-        field = double
-        expect(field).to receive(:type=).with(:text)
-
-        @form.fill_in :name, with: field
-      end
-      
-      it 'sets the field type for choose' do
-        field = double
-        expect(field).to receive(:type=).with(:radio)
-
-        @form.choose field
-      end
-
-      # this tests fails and I don't know why! (rspec's fault not mine.. I think)
-      it 'sets the field type for select' do
-        skip "RSpec's fault"
-        field = double
-        expect(field).to receive(:type=).with(:select)
-
-        @form.select field
-      end
+  describe "#method_missing" do
+    it "ignores actions" do
+      expect { @form.fill_in "Name", with: @form.field(:name) }.to_not raise_error
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conformity
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Nikias Kalpaxis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -66,12 +66,12 @@ files:
 - Rakefile
 - conformity.gemspec
 - lib/conformity.rb
-- lib/conformity/action.rb
+- lib/conformity/actions.rb
 - lib/conformity/field.rb
 - lib/conformity/form.rb
 - lib/conformity/success_conditions.rb
 - lib/conformity/version.rb
-- spec/action_spec.rb
+- spec/actions_spec.rb
 - spec/field_spec.rb
 - spec/form_spec.rb
 - spec/spec_helper.rb
@@ -101,7 +101,7 @@ signing_key:
 specification_version: 4
 summary: Automates form submissions by building upon Capybara.
 test_files:
-- spec/action_spec.rb
+- spec/actions_spec.rb
 - spec/field_spec.rb
 - spec/form_spec.rb
 - spec/spec_helper.rb

data/lib/conformity/action.rb

@@ -1,37 +0,0 @@
-module Conformity
-  class Action
-    include Capybara::DSL
-
-    attr_reader :name, :args, :block
-
-    def initialize(name, args = [], block = nil)
-      @name = name
-      @args = args
-      @block = block
-    end
-
-    def field
-      @field ||= case name
-        when :fill_in then args.last[:with]
-        when :choose  then args.first
-        when :select  then args.first
-      end
-    end
-
-    def run
-      case name
-      when :fill_in
-        return unless field.value
-        args.last[:with] = field.value
-      when :choose, :select
-        return unless field.value
-        args.first = field.value
-      end if field
-
-      result = send(name, *args, &block)
-      if !result && result['status'] == 'fail'
-        raise ActionError, "Capybara status: #{result}" 
-      end
-    end
-  end
-end

data/spec/action_spec.rb

@@ -1,39 +0,0 @@
-require_relative 'spec_helper'
-require 'conformity/action'
-
-
-describe Conformity::Action do
-  before :each do
-    @field = double('field', value: 'quack')
-  end
-
-  describe '#field' do
-    it 'locates the field duck type for fill_in' do
-      action = Action.new(:fill_in, ['#name', with: @field])
-
-      expect(action.field).to respond_to(:value)
-    end
-
-    it 'locates the field duck type for choose' do
-      action = Action.new(:choose, [@field])
-
-      expect(action.field).to respond_to(:value)
-    end
-
-    it 'locates the field duck type for select' do
-      action = Action.new(:select, [@field])
-
-      expect(action.field).to respond_to(:value)
-    end
-  end
-
-  describe '#run' do
-    it 'delegates to Capybara::DSL' do
-      skip
-      action = Action.new(:click_on, ['#submit'])
-
-      expect(Capybara::DSL).to receive(:check).with('#submit')
-      action.run
-    end
-  end
-end