proto_cat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de9f7f1818b3b4933f146410674db48dd5c7558a
+  data.tar.gz: 762b11e6b470e752bc7ec33565ae7ca73aeeabc7
+SHA512:
+  metadata.gz: 528c23d41c529519067c325e1c8e0a4e9d13be9c397eaec0d0485c8ab9ade9938c05b287e2ec07f23079e00a7f960198f8eb95dff77b885f5e9a37c1204dff61
+  data.tar.gz: 7c8347bd1e13ebb1d94bebddda82406c69d8f4bc21c1a7aaa442fae4dc0b34baacdca7143104152eb8e4291b8bbd25872a6950ef7d00c36ca594c5d9738c2062

data/.gitignore

@@ -0,0 +1,16 @@
+coverage
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in proto_cat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mohammad Satrio
+
+MIT License
+
+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,31 @@
+# ProtoCat
+
+Protocol/Interface for Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proto_cat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proto_cat
+
+## Usage
+
+TODO: Write usage instructions. For now you can see the specs for how to use it.
+
+## Contributing
+
+1. Fork it ( https://github.com/tyok/proto_cat/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/proto_cat.rb

@@ -0,0 +1,15 @@
+require_relative('proto_cat/protocol_module')
+require_relative('proto_cat/object')
+
+module ProtoCat
+  extend self
+
+  def define_protocol(&block)
+    ProtocolModule.new(&block)
+  end
+
+  def object(obj)
+    Object.new(obj)
+  end
+
+end

data/lib/proto_cat/error/not_implemented_error.rb

@@ -0,0 +1,22 @@
+module ProtoCat
+  class NotImplementedError < StandardError
+
+    attr_reader :protocol, :object
+
+    def initialize(protocol, object)
+      @protocol = protocol
+      @object = object
+
+      super(not_implemented_message)
+    end
+
+    def not_implemented_message
+      "#{protocol} is not implemented properly on #{object}: #{failure_string}"
+    end
+
+    def failure_string
+      protocol.failure_strings(object).join('\n')
+    end
+
+  end
+end

data/lib/proto_cat/object.rb

@@ -0,0 +1,17 @@
+module ProtoCat
+  class Object
+
+    def initialize(object)
+      @object = object
+    end
+
+    def satisfy?(protocol)
+      protocol.satisfied_by?(@object)
+    end
+
+    def satisfy!(protocol)
+      protocol.satisfied_by!(@object)
+    end
+
+  end
+end

data/lib/proto_cat/protocol.rb

@@ -0,0 +1,32 @@
+require_relative 'error/not_implemented_error'
+
+module ProtoCat
+  class Protocol
+
+    def initialize(mod, criteria)
+      @module = mod
+      @criteria = criteria
+    end
+
+    def satisfied_by!(object)
+      satisfied_by?(object) or raise NotImplementedError.new(self, object)
+    end
+
+    def satisfied_by?(object)
+      @criteria.all? {|crit| crit.satisfied_by?(object) }
+    end
+
+    def failed_criteria(object)
+      @criteria.reject {|crit| crit.satisfied_by?(object) }
+    end
+
+    def failure_strings(object)
+      failed_criteria(object).map(&:failure_string)
+    end
+
+    def to_s
+      @module.to_s
+    end
+
+  end
+end

data/lib/proto_cat/protocol_builder.rb

@@ -0,0 +1,17 @@
+require_relative 'protocol_method'
+
+module ProtoCat
+  class ProtocolBuilder
+
+    attr_reader :criteria
+
+    def initialize
+      @criteria = []
+    end
+
+    def has_method(*args)
+      @criteria.push(ProtocolMethod.new(*args))
+    end
+
+  end
+end

data/lib/proto_cat/protocol_method.rb

@@ -0,0 +1,21 @@
+module ProtoCat
+  class ProtocolMethod
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def satisfied_by?(object)
+      object.methods.include?(name)
+    end
+
+    def failure_string
+      "#{name} not found"
+    end
+
+    alias_method :to_s, :name
+
+  end
+end

data/lib/proto_cat/protocol_module.rb

@@ -0,0 +1,32 @@
+require 'forwardable'
+require_relative 'protocol'
+require_relative 'protocol_builder'
+
+module ProtoCat
+  class ProtocolModule < Module
+    extend Forwardable
+
+    def_delegators :protocol, :satisfied_by?, :satisfied_by!
+    attr_reader :protocol
+
+    def initialize(&block)
+      builder = ProtocolBuilder.new
+      block.call(builder)
+      @protocol = Protocol.new(self, builder.criteria)
+    end
+
+    def included(klass)
+      protocol.satisfied_by!(Class.new(klass))
+    end
+
+    def extended(obj)
+      protocol.satisfied_by!(obj)
+    end
+
+    Class = Struct.new(:object) do
+      extend Forwardable
+      def_delegator :object, :instance_methods, :methods
+    end
+
+  end
+end

data/lib/proto_cat/version.rb

@@ -0,0 +1,3 @@
+module ProtoCat
+  VERSION = '0.0.1'
+end

data/lib/proto_cat/with_sugar.rb

@@ -0,0 +1,26 @@
+require 'forwardable'
+require_relative('../proto_cat')
+
+module ProtoCat
+
+  class ProtocolModule
+    extend Forwardable
+    def_delegators :protocol, :===, :must
+  end
+
+  class Protocol
+
+    alias_method :===, :satisfied_by?
+
+    def must
+      Enforcer.new(self)
+    end
+
+    Enforcer = Struct.new(:protocol) do
+      extend Forwardable
+      def_delegator :protocol, :satisfied_by!, :===
+    end
+
+  end
+
+end

data/proto_cat.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'proto_cat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "proto_cat"
+  spec.version       = ProtoCat::VERSION
+  spec.authors       = ["Mohammad Satrio"]
+  spec.email         = ["wolfaeon@gmail.com"]
+  spec.summary       = %q{Protocol/Interface for Ruby}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/tyok/proto_cat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/proto_cat_spec.rb

@@ -0,0 +1,107 @@
+require 'ostruct'
+require_relative 'spec_helper'
+require_relative '../lib/proto_cat'
+
+RSpec.describe ProtoCat do
+
+  before do
+    IsCat ||= ProtoCat.define_protocol do |p|
+      p.has_method(:meow)
+      p.has_method(:leg)
+    end
+
+    @cat = OpenStruct.new(meow: 'meow', leg: 4)
+    @dog = OpenStruct.new(bark: 'bark', leg: 4)
+  end
+
+  describe 'Protocol' do
+
+    describe '#satisfied_by?' do
+
+      it 'returns true when the protocol is satisfied' do
+        expect( IsCat.satisfied_by? @cat ).to eq(true)
+        expect( IsCat.satisfied_by? @dog ).to eq(false)
+      end
+
+    end
+
+    describe '#satisfied_by!' do
+
+      it 'raise error when the protocol is not satisfied' do
+        expect( IsCat.satisfied_by! @cat ).to eq(true)
+        expect{ IsCat.satisfied_by! @dog }.to raise_error(ProtoCat::NotImplementedError)
+      end
+
+    end
+
+  end
+
+  describe 'Object' do
+
+    describe '#satisfy?' do
+
+      it 'returns true when the object satisfies the protocol' do
+        expect( ProtoCat.object(@cat).satisfy? IsCat ).to eq(true)
+        expect( ProtoCat.object(@dog).satisfy? IsCat ).to eq(false)
+      end
+
+    end
+
+    describe '#satisfy!' do
+
+      it 'raise error when the object doesn\'t satisfy the protocol'  do
+        expect( ProtoCat.object(@cat).satisfy! IsCat ).to eq(true)
+        expect{ ProtoCat.object(@dog).satisfy! IsCat }.to raise_error(ProtoCat::NotImplementedError)
+      end
+
+    end
+
+  end
+
+  describe 'Module' do
+
+    it 'doesn\'t raise error when the including class satisfies the protocol' do
+      define_class = proc do
+
+        cat_class = Class.new do
+          def meow
+            'meow'
+          end
+
+          def leg
+            4
+          end
+        end
+        cat_class.include(IsCat)
+
+      end
+
+      expect(&define_class).not_to raise_error
+    end
+
+    it 'raises error when the including class doesn\'t satisfy the protocol' do
+      define_class = proc do
+
+        cat_class = Class.new do
+          def meow
+            'meow'
+          end
+        end
+        cat_class.include(IsCat)
+
+      end
+
+      expect(&define_class).to raise_error(ProtoCat::NotImplementedError)
+    end
+
+    it 'doesn\'t raise error when the extending object satisfies the protocol' do
+      expect{ @cat.extend(IsCat) }.not_to raise_error
+    end
+
+    it 'raises error when the extending object doesn\'t satisfy the protocol' do
+      expect{ @dog.extend(IsCat) }.to raise_error(ProtoCat::NotImplementedError)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+

data/spec/sugar_spec.rb

@@ -0,0 +1,29 @@
+require 'ostruct'
+require_relative 'spec_helper'
+require_relative '../lib/proto_cat/with_sugar'
+
+RSpec.describe ProtoCat do
+  before do
+    IsCat ||= ProtoCat.define_protocol do |p|
+      p.has_method(:meow)
+      p.has_method(:leg)
+    end
+
+    @cat = OpenStruct.new(meow: 'meow', leg: 4)
+    @dog = OpenStruct.new(bark: 'bark', leg: 4)
+  end
+
+  describe '===' do
+    it 'behaves like #satisfied_by?' do
+      expect( IsCat === @cat ).to eq(true)
+      expect( IsCat === @dog ).to eq(false)
+    end
+  end
+
+  describe 'must ===' do
+    it 'behaves like #satisfied_by!' do
+      expect( IsCat.must === @cat ).to eq(true)
+      expect{ IsCat.must === @dog }.to raise_error(ProtoCat::NotImplementedError)
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: proto_cat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mohammad Satrio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email:
+- wolfaeon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/proto_cat.rb
+- lib/proto_cat/error/not_implemented_error.rb
+- lib/proto_cat/object.rb
+- lib/proto_cat/protocol.rb
+- lib/proto_cat/protocol_builder.rb
+- lib/proto_cat/protocol_method.rb
+- lib/proto_cat/protocol_module.rb
+- lib/proto_cat/version.rb
+- lib/proto_cat/with_sugar.rb
+- proto_cat.gemspec
+- spec/proto_cat_spec.rb
+- spec/spec_helper.rb
+- spec/sugar_spec.rb
+homepage: https://github.com/tyok/proto_cat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Protocol/Interface for Ruby
+test_files:
+- spec/proto_cat_spec.rb
+- spec/spec_helper.rb
+- spec/sugar_spec.rb
+has_rdoc: