duck_testing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c61f7e63d611d677991d9cbcb05502a4bb8db7dd
+  data.tar.gz: 4f70acbf27363df964538e5bc42e3f72082f66ae
+SHA512:
+  metadata.gz: 49fb0118fb936af49cf4e7b0c837c3f17d2b5ed06f87aaea02f9bc1857da41d5941224423f861c0511895f5abfae7cfc614fea45fd7fed6771bad839aaf263b9
+  data.tar.gz: ead4d4cc67a9117e93332c4a2b3ad573972dee042394c2c2f418806d074b1186c852da6e28511ff18cd8ed3ce88404cbdd778631edbf1c07d7b1aa3bf0d4ed73

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+spec/examples.txt

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format doc
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 25
+
+# Document classes and non-namespace modules.
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingComma:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0-p647
+  - 2.1.7
+  - 2.2.3
+notifications:
+    email: false

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+-
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "coveralls", require: false
+end

data/Guardfile

@@ -0,0 +1,19 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yuku TAKAHASHI
+
+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,75 @@
+# DuckTesting
+
+[![Build Status](https://travis-ci.org/yuku-t/duck_testing.svg?branch=master)](https://travis-ci.org/yuku-t/duck_testing) [![Code Climate](https://codeclimate.com/github/yuku-t/duck_testing/badges/gpa.svg)](https://codeclimate.com/github/yuku-t/duck_testing) [![Coverage Status](https://coveralls.io/repos/yuku-t/duck_testing/badge.svg)](https://coveralls.io/r/yuku-t/duck_testing)
+
+Simple data type testing tool
+
+## Usage
+
+### YARD
+
+```rb
+require "duck_testing"
+
+DuckTesting::YARD.apply
+```
+
+This code automatically generates duck_testing module for all classes in `{lib,app}/**/*.rb` and prepends them into corresponding classes. In most cases, you might put the code in `spec/spec_helper.rb` or `test/test_helper.rb`.
+
+You can include and exclude custom paths by using `paths` and `excluded` arguments. For instance, excluding Rails' controllers and views is written as follows:
+
+```rb
+DuckTesting::YARD.apply(excluded: [%r{^app/(controllers|views)}])
+```
+
+### Manually
+
+Suppose there are a class and corresponding _duck_testing_ module:
+
+```rb
+require "duck_testing"
+
+class Foo
+  # @param [Fixnum, Float]
+  # @return [Fixnum, Float]
+  def double(x)
+    x * 2
+  end
+end
+
+module FooDuckTesting
+  def double(x)
+    tester = DuckTesting::Tester.new(self, "double")
+    tester.test_param(x, [
+      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
+```
+
+Now you can activate type testing by prepending _duck_testing_ module into the class:
+
+```rb
+before = Foo.new
+
+before.double("2")
+# => "22"
+
+Foo.send(:prepend, FooDuckTesting)
+
+after = Foo.new
+
+after.double(2)
+# => 4
+
+after.double(2.0)
+# => 4.0
+
+after.double("2")
+# ContractViolationError: Contract violation for argument Foo#double
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/duck_testing.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "duck_testing/version"
+
+Gem::Specification.new do |spec|
+  spec.name                  = "duck_testing"
+  spec.version               = DuckTesting::VERSION
+  spec.authors               = ["Yuku Takahashi"]
+  spec.email                 = ["taka84u9@gmail.com"]
+  spec.summary               = "Data type testing tool"
+  spec.description           = "Data type testing tool"
+  spec.license               = "MIT"
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.homepage              = "https://github.com/yuku-t/duck_testing"
+
+  spec.add_dependency "yard", "~> 0.8.7"
+
+  spec.add_development_dependency "guard", "~> 2.12"
+  spec.add_development_dependency "guard-rspec", "~> 4.6"
+  spec.add_development_dependency "guard-rubocop", "~> 1.2"
+  spec.add_development_dependency "pry", "~> 0.10.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "rubocop", "~> 0.35.1"
+end

data/lib/duck_testing.rb

@@ -0,0 +1,19 @@
+require "duck_testing/errors"
+require "duck_testing/method_call_data"
+require "duck_testing/reporter/raise_error"
+require "duck_testing/tester"
+require "duck_testing/type/class_instance"
+require "duck_testing/type/constant"
+require "duck_testing/type/duck_type"
+require "duck_testing/type/hash"
+require "duck_testing/type/order_dependent_array"
+require "duck_testing/type/order_independent_array"
+require "duck_testing/version"
+require "duck_testing/violation"
+require "duck_testing/yard"
+require "duck_testing/yard/builder"
+require "duck_testing/yard/class_object"
+require "duck_testing/yard/code_object"
+require "duck_testing/yard/method_object"
+require "duck_testing/yard/method_parameter"
+require "duck_testing/yard/parser"

data/lib/duck_testing/errors.rb

@@ -0,0 +1,4 @@
+module DuckTesting
+  class ContractViolationError < StandardError
+  end
+end

data/lib/duck_testing/method_call_data.rb

@@ -0,0 +1,19 @@
+module DuckTesting
+  class MethodCallData
+    # @param receiver [Object] the receiver object.
+    # @param method_name [String] the invoked method's name.
+    def initialize(receiver, method_name)
+      @receiver = receiver
+      @method_name = method_name
+    end
+
+    # @return [String]
+    def method_expr
+      "#{receiver.class.name}##{method_name}"
+    end
+
+    private
+
+    attr_reader :receiver, :method_name
+  end
+end

data/lib/duck_testing/reporter/base.rb

@@ -0,0 +1,17 @@
+module DuckTesting
+  module Reporter
+    class Base
+      attr_reader :violation
+
+      # @param violation [DuckTesting::Violation]
+      def initialize(violation)
+        @violation = violation
+      end
+
+      # Report contract violation.
+      def report
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/duck_testing/reporter/raise_error.rb

@@ -0,0 +1,30 @@
+require "duck_testing/reporter/base"
+
+module DuckTesting
+  module Reporter
+    class RaiseError < Base
+      # @note Override {DuckTesting::Reporter::Base#report}.
+      def report
+        fail ContractViolationError, failure_message
+      end
+
+      private
+
+      def failure_message
+        %(#{message_header}
+            Expected: #{violation.expected}
+            Actual: #{violation.param.inspect})
+      end
+
+      def message_header
+        if violation.param?
+          "Contract violation for argument of #{violation.method_expr}"
+        elsif violation.return?
+          "Contract violation for return value from #{violation.method_expr}"
+        else
+          fail NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/duck_testing/tester.rb

@@ -0,0 +1,50 @@
+module DuckTesting
+  class Tester
+    attr_reader :call_data
+
+    # @param receiver [Object] the receiver object.
+    # @param method_name [String] the invoked method's name.
+    def initialize(receiver, method_name)
+      @call_data = MethodCallData.new(receiver, method_name)
+    end
+
+    # @param param [Object]
+    # @param expected_types [Array<DuckTesting::Type::Base>]
+    def test_param(param, expected_types)
+      test(param, expected_types, :param)
+    end
+
+    # @param param [Object]
+    # @param expected_types [Array<DuckTesting::Type::Base>]
+    # @return [Object]
+    def test_return(param, expected_types)
+      test(param, expected_types, :return)
+      param
+    end
+
+    # @param param [Object]
+    # @param expected_types [Array<DuckTesting::Type::Base>]
+    # @return [Boolean]
+    def match?(param, expected_types)
+      expected_types.any? do |type|
+        type.match?(param)
+      end
+    end
+
+    private
+
+    # @param param [Object]
+    # @param expected_types [Array<DuckTesting::Type::Base>]
+    # @param type [Symbol] `:param` or `:return`
+    def test(param, expected_types, type)
+      return if match?(param, expected_types) || expected_types.empty?
+      violation = Violation.new(
+        call_data: call_data,
+        param: param,
+        expected_types: expected_types,
+        param_or_return: type
+      )
+      Reporter::RaiseError.new(violation).report
+    end
+  end
+end

data/lib/duck_testing/type/base.rb

@@ -0,0 +1,13 @@
+module DuckTesting
+  module Type
+    class Base
+      def match?(_object)
+        fail NotImplementedError
+      end
+
+      def to_s
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/duck_testing/type/class_instance.rb

@@ -0,0 +1,24 @@
+require "duck_testing/type/base"
+
+module DuckTesting
+  module Type
+    class ClassInstance < Base
+      attr_reader :klass
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # @param object [Object]
+      # @return [Boolean]
+      def match?(object)
+        object.is_a?(klass)
+      end
+
+      # @return [String]
+      def to_s
+        klass.name
+      end
+    end
+  end
+end

data/lib/duck_testing/type/constant.rb

@@ -0,0 +1,26 @@
+require "duck_testing/type/base"
+
+module DuckTesting
+  module Type
+    class Constant < Base
+      CONSTANTS = %w(true false)
+
+      attr_reader :constant
+
+      def initialize(constant)
+        @constant = constant
+      end
+
+      # @param object [Object]
+      # @return [Boolean]
+      def match?(object)
+        object == constant
+      end
+
+      # @return [String]
+      def to_s
+        constant.to_s
+      end
+    end
+  end
+end