duck_testing 0.0.1

data/spec/order_dependent_array_type_integration_spec.rb

@@ -0,0 +1,121 @@
+describe "OrderIndependentArray type integration spec" do
+  subject do
+    instance.find(*params)
+  end
+
+  before do
+    klass.send(:prepend, duck_testing_module)
+  end
+
+  let(:instance) { klass.new }
+
+  let(:klass) do
+    Class.new do
+      # @param keylist [Array<Array<(Symbol, Object)>>]
+      # @param key [Symbol]
+      # @return [Object]
+      def find(keylist, key)
+        keylist.each do |(k, value)|
+          return value if k == key
+        end
+        nil
+      end
+    end
+  end
+
+  context "when expected parameter and return are given" do
+    let(:params) { [[[:a, 1], [:b, 2]], :b] }
+
+    let(:duck_testing_module) do
+      Module.new do
+        def find(keylist, key)
+          tester = DuckTesting::Tester.new(self, "find")
+          tester.test_param(keylist, [
+            DuckTesting::Type::OrderIndependentArray.new(
+              DuckTesting::Type::OrderDependentArray.new(
+                DuckTesting::Type::ClassInstance.new(Symbol),
+                DuckTesting::Type::ClassInstance.new(Object)
+              )
+            )
+          ])
+          tester.test_param(key, [
+            DuckTesting::Type::ClassInstance.new(Symbol)
+          ])
+          tester.test_return(super, [
+            DuckTesting::Type::ClassInstance.new(Object)
+          ])
+        end
+      end
+    end
+
+    it "does not raise error" do
+      expect { subject }.not_to raise_error
+    end
+
+    it "returns original result" do
+      should eq 2
+    end
+  end
+
+  context "when unexpected parameter is given" do
+    let(:params) { [[["a", 1], ["b", 2]], "b"] }
+
+    let(:duck_testing_module) do
+      Module.new do
+        def find(keylist, key)
+          tester = DuckTesting::Tester.new(self, "find")
+          tester.test_param(keylist, [
+            DuckTesting::Type::OrderIndependentArray.new(
+              DuckTesting::Type::OrderDependentArray.new(
+                DuckTesting::Type::ClassInstance.new(Symbol),
+                DuckTesting::Type::ClassInstance.new(Object)
+              )
+            )
+          ])
+          tester.test_param(key, [
+            DuckTesting::Type::ClassInstance.new(Symbol)
+          ])
+          tester.test_return(super, [
+            DuckTesting::Type::ClassInstance.new(Object)
+          ])
+        end
+      end
+    end
+
+    it "raises ContractViolationError" do
+      expect { subject }.to raise_error(DuckTesting::ContractViolationError)
+      expect { subject }.to raise_error(/Contract violation for argument/)
+    end
+  end
+
+  context "when unexpected result is given" do
+    let(:params) { [[[:a, 1], [:b, 2]], :b] }
+
+    let(:duck_testing_module) do
+      Module.new do
+        def find(keylist, key)
+          tester = DuckTesting::Tester.new(self, "find")
+          tester.test_param(keylist, [
+            DuckTesting::Type::OrderIndependentArray.new(
+              DuckTesting::Type::OrderDependentArray.new(
+                DuckTesting::Type::ClassInstance.new(Symbol),
+                DuckTesting::Type::ClassInstance.new(Object)
+              )
+            )
+          ])
+          tester.test_param(key, [
+            DuckTesting::Type::ClassInstance.new(Symbol)
+          ])
+          tester.test_return(super, [
+            DuckTesting::Type::ClassInstance.new(Symbol)
+          ])
+        end
+      end
+    end
+
+    it "raises ContractViolationError" do
+      expect { subject }.to raise_error(DuckTesting::ContractViolationError)
+      expect { subject }.to raise_error(/Contract violation for return value/)
+    end
+  end
+end

data/spec/order_independent_array_type_integration_spec.rb

@@ -0,0 +1,104 @@
+describe "OrderIndependentArray type integration spec" do
+  subject do
+    instance.sum(param)
+  end
+
+  before do
+    klass.send(:prepend, duck_testing_module)
+  end
+
+  let(:instance) { klass.new }
+
+  let(:klass) do
+    Class.new do
+      # @param array [Array<Fixnum, Float>]
+      # @return [Fixnum, Float]
+      def sum(array)
+        array.reduce(&:+)
+      end
+    end
+  end
+
+  context "when expected parameter and return are given" do
+    let(:param) { [1, 0.1] }
+
+    let(:duck_testing_module) do
+      Module.new do
+        def sum(array)
+          tester = DuckTesting::Tester.new(self, "sum")
+          tester.test_param(array, [
+            DuckTesting::Type::OrderIndependentArray.new(
+              DuckTesting::Type::ClassInstance.new(Fixnum),
+              DuckTesting::Type::ClassInstance.new(Float)
+            )
+          ])
+          tester.test_return(super, [
+            DuckTesting::Type::ClassInstance.new(Fixnum),
+            DuckTesting::Type::ClassInstance.new(Float)
+          ])
+        end
+      end
+    end
+
+    it "does not raise error" do
+      expect { subject }.not_to raise_error
+    end
+
+    it "returns original result" do
+      should eq 1.1
+    end
+  end
+
+  context "when unexpected parameter is given" do
+    let(:param) { "string" }
+
+    let(:duck_testing_module) do
+      Module.new do
+        def sum(array)
+          tester = DuckTesting::Tester.new(self, "sum")
+          tester.test_param(array, [
+            DuckTesting::Type::OrderIndependentArray.new(
+              DuckTesting::Type::ClassInstance.new(Fixnum),
+              DuckTesting::Type::ClassInstance.new(Float)
+            )
+          ])
+          tester.test_return(super, [
+            DuckTesting::Type::ClassInstance.new(Fixnum),
+            DuckTesting::Type::ClassInstance.new(Float)
+          ])
+        end
+      end
+    end
+
+    it "raises ContractViolationError" do
+      expect { subject }.to raise_error(DuckTesting::ContractViolationError)
+      expect { subject }.to raise_error(/Contract violation for argument/)
+    end
+  end
+
+  context "when unexpected result is given" do
+    let(:param) { [1, 0.1] }
+
+    let(:duck_testing_module) do
+      Module.new do
+        def sum(array)
+          tester = DuckTesting::Tester.new(self, "sum")
+          tester.test_param(array, [
+            DuckTesting::Type::OrderIndependentArray.new(
+              DuckTesting::Type::ClassInstance.new(Fixnum),
+              DuckTesting::Type::ClassInstance.new(Float)
+            )
+          ])
+          tester.test_return(super, [
+            DuckTesting::Type::ClassInstance.new(String)
+          ])
+        end
+      end
+    end
+
+    it "raises ContractViolationError" do
+      expect { subject }.to raise_error(DuckTesting::ContractViolationError)
+      expect { subject }.to raise_error(/Contract violation for return value/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+require "coveralls"
+Coveralls.wear!
+
+require "duck_testing"
+require "pry"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  config.expose_dsl_globally = true
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: duck_testing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuku Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+description: Data type testing tool
+email:
+- taka84u9@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- duck_testing.gemspec
+- lib/duck_testing.rb
+- lib/duck_testing/errors.rb
+- lib/duck_testing/method_call_data.rb
+- lib/duck_testing/reporter/base.rb
+- lib/duck_testing/reporter/raise_error.rb
+- lib/duck_testing/tester.rb
+- lib/duck_testing/type/base.rb
+- lib/duck_testing/type/class_instance.rb
+- lib/duck_testing/type/constant.rb
+- lib/duck_testing/type/duck_type.rb
+- lib/duck_testing/type/hash.rb
+- lib/duck_testing/type/order_dependent_array.rb
+- lib/duck_testing/type/order_independent_array.rb
+- lib/duck_testing/version.rb
+- lib/duck_testing/violation.rb
+- lib/duck_testing/yard.rb
+- lib/duck_testing/yard/builder.rb
+- lib/duck_testing/yard/class_object.rb
+- lib/duck_testing/yard/code_object.rb
+- lib/duck_testing/yard/method_object.rb
+- lib/duck_testing/yard/method_parameter.rb
+- lib/duck_testing/yard/parser.rb
+- sample/.gitignore
+- sample/.rspec
+- sample/Gemfile
+- sample/lib/concern.rb
+- sample/lib/sample.rb
+- sample/spec/sample_spec.rb
+- sample/spec/spec_helper.rb
+- spec/.rubocop.yml
+- spec/class_type_integration_spec.rb
+- spec/constant_type_integration_spec.rb
+- spec/duck_testing/method_call_data_spec.rb
+- spec/duck_testing/reporter/raise_error_spec.rb
+- spec/duck_testing/tester_spec.rb
+- spec/duck_testing/violation_spec.rb
+- spec/duck_testing/yard/builder_spec.rb
+- spec/duck_testing/yard/parser_spec.rb
+- spec/duck_type_integration_spec.rb
+- spec/hash_type_integration_spec.rb
+- spec/order_dependent_array_type_integration_spec.rb
+- spec/order_independent_array_type_integration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yuku-t/duck_testing
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Data type testing tool
+test_files: []
+has_rdoc: