ruby-interface 0.0.6

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "bluecloth"
+  gem "rr"
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    ruby-interface (0.0.6)
+      activesupport (> 0.1)
+      i18n (> 0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.7)
+    bluecloth (2.1.0)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rr (1.0.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    yard (0.6.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rr
+  rspec (~> 2.3.0)
+  ruby-interface!
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andrew Rudenko
+
+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,93 @@
+RubyInterface
+=============
+
+Простенький патерн определения интерфейсов в руби. В противовес стандартным миксинам, для каждого интерфейса создается свой класс и соответсвенно экземпляр класса для каждого объекта с интерфейсом.
+
+    module Tree
+      extend RubyInterface
+      interface :tree do
+        include Enumerable
+        attr_accessor :parent
+    
+        def childs
+          @childs ||= []
+        end
+    
+        def each(&blk)
+          blk.call(owner)
+          childs.each { |v| v.tree.each(&blk) }
+        end
+    
+        def set_parent(parent)
+          parent.tree.childs << owner
+          @parent = parent
+        end
+      end
+    end
+
+    class A
+      include Tree
+    end
+
+При разработке интерфейса не нужно задумываться о конфликтах имен переменных, методов, можно делать все что угодно. Аргументом к методу interface передается название метода, по которому этот интерфейс будет доступен.
+
+    a = A.new
+    b = A.new
+
+    a.tree.set_parent b
+    b.tree.childs # => [a]
+    b.tree.map { |o| o } # => [b, a]
+    
+А при использовании методов относящихся к интерфейсу мы явно видим к какому же интерфейсу он относится. Всем профит!
+
+В интерфейсе доступен метод owner, возвращающий родительский объект. У класса интерфейса есть <tt>interface_base</tt>, возвращающий класс, куда интерфейс был заинклужен.
+
+Помимо инстанс метода, создается так же класс-метод. В него можно передать блок, который выполнится в скоупе класса интерфейса. Сам метод возвращает класс интерфейса.
+
+    module StateMachine
+      extend RubyInterface
+      interface :state_machine do
+        def self.state(name)
+          puts "New state #{name}"
+        end
+      end
+    end
+
+    class A
+      include StateMachine
+  
+      state_machine do
+        state(:parked) # => New state parked
+        state(:idling) # => New state idling
+      end
+    end
+    
+При наследовании класса с интерфейсом, создается новый класс интерфейса и наследуется от предыдущего, т.е. повторяет иерархию класса, в который он включен.
+
+Если в блоке <tt>interface</tt> вызывается метод <tt>interfaced</tt>, то исполнение блока, передаваемого <tt>interfaced</tt> 
+происходит после добавления интерфейса в класс, в контексте этого класса.
+
+Пример:
+   
+     module A
+       extend RubyInterface
+       interface :int do
+         interfaced do
+           def baz
+             self.class.int_interface.foo
+           end
+         end
+     
+         def self.foo
+           "bar"
+         end
+       end
+     end
+     
+     class B
+       include A
+     end
+     
+     B.new.baz # => "bar"
+
+В каждом модуле может быть определено произвольное количество интерфейсов

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/ruby-interface/version.rb

@@ -0,0 +1,3 @@
+module RubyInterface
+  VERSION = "0.0.6"
+end

data/lib/ruby-interface/yard.rb

@@ -0,0 +1,8 @@
+class RubyInterfaceHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:interface)
+  
+  def process
+    parse_block(statement.last.last)
+  rescue YARD::Handlers::NamespaceMissingError
+  end
+end

data/lib/ruby_interface.rb

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+
+module RubyInterface
+  def interface(method_name, &interface_body)
+    mod_inst = self.const_set("#{method_name.to_s.camelize}InstanceMethods", Module.new)
+    mod_inst.module_eval <<-EOT, __FILE__, __LINE__ + 1
+      def #{method_name}
+        @#{method_name}_interface ||= self.class.#{method_name}_interface.new(self)
+      end                                                             
+      EOT
+
+
+    mod_class = self.const_set("#{method_name.to_s.camelize}ClassMethods", Module.new)
+    mod_class.module_eval <<-EOT, __FILE__, __LINE__ + 1
+      def #{method_name}(&blk)
+        self.#{method_name}_interface.class_eval(&blk) if blk
+        self.#{method_name}_interface
+      end
+
+      def inherited(subclass)
+        new_class = subclass.const_set("#{method_name.to_s.camelize}InterfaceClass", Class.new(self.#{method_name}_interface))
+        new_class.interface_base = subclass
+        subclass.#{method_name}_interface = new_class
+        super
+      end
+      EOT
+
+    interface_module = self
+    
+    add_interface do |base|
+      base.send(:class_attribute, "#{method_name}_interface")
+      interface_class = base.const_set("#{method_name.to_s.camelize}InterfaceClass", Class.new(RubyInterface::InterfaceClass))
+      interface_class.interface_base = base
+      interface_class.class_eval(&interface_body) if interface_body
+      base.send("#{method_name}_interface=", interface_class)
+      base.extend mod_class
+      base.send :include, mod_inst
+      base.class_eval(&interface_class.interfaced) if interface_class.interfaced
+    end
+
+    interface_module.define_singleton_method(:included) do |base|
+      @_deps.each {|d| d.call(base)}
+    end
+  end
+
+  private
+  def add_interface &block
+    @_deps ||= []
+    @_deps << block
+  end
+
+  class InterfaceClass
+    class_attribute :interface_base
+    attr_accessor :owner      
+    def initialize(owner)
+      @owner = owner
+    end
+
+    class << self
+      def interfaced(&block)
+        if block_given?
+          @_interfaced_block = block
+        else
+          @_interfaced_block
+        end
+      end
+    end
+  end
+end

data/ruby-interface.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ruby-interface/version"
+
+Gem::Specification.new do |s|
+  s.name = %q{ruby-interface}
+  s.version = RubyInterface::VERSION
+  s.summary = "Ruby interface"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Rudenko", "Nick Recobra"]
+  s.date = %q{2011-03-24}
+  s.description = %q{Ruby interface}
+  s.email = %q{ceo@prepor.ru}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('activesupport', ["> 0.1"])
+  s.add_dependency(%q<i18n>, ["> 0.1"])
+end

data/spec/ruby_interface_spec.rb

@@ -0,0 +1,127 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe RubyInterface do
+  def make_interface
+    mod = Module.new
+    mod.extend(RubyInterface)
+    mod
+  end
+  
+  describe "Создание интерфейса" do
+    let(:mod) { make_interface.tap { |v| v.interface(:test) } }
+    
+    it "должен вызываться interfaced, если определен" do
+      @proc = proc {}
+      klass = Class.new
+      mod.interface :int do
+        interfaced(&@proc)
+      end
+      mock(klass).class_eval(&@proc)
+      mock(klass).class_eval(&@proc)
+      klass.send :include, mod
+    end
+    
+    describe "Класс с интерфейсом" do
+      subject { klass }
+      let(:klass) { Class.new.tap { |v| v.send :include, mod } }
+      let(:interface_klass) { klass.test_interface }
+      its(:test) { should eq(interface_klass) }
+      
+      it "может дополнять класс интерфейса" do
+        interface_klass.respond_to?(:test).should be_false
+        klass.test do
+          mattr_accessor :test
+        end
+        interface_klass.respond_to?(:test).should be_true
+      end
+      
+      it "должен содержать класс интерфейса" do
+        klass::TestInterfaceClass.ancestors.should include(RubyInterface::InterfaceClass)
+        klass.test_interface.should eq(klass::TestInterfaceClass)
+      end
+      
+      describe "Класс интерфейса" do
+        subject { interface_klass }
+        its(:interface_base) { should eq(klass) }
+        
+        describe "Объект с интерфейсом" do
+          subject { obj }
+          let(:obj) { klass.new }
+          its(:test) { should be_kind_of(interface_klass)}
+          describe "Объект интерфейса" do
+            subject { interface_obj }
+            let(:interface_obj) { obj.test }
+            its(:owner) { should eq(obj) }
+            let(:mod) do 
+              make_interface.tap do |v| 
+                v.interface(:test) do
+                  def foo
+                    "bar"
+                  end
+                end
+              end              
+            end
+            
+            it "должен поддерживать методы определенные в интерфейсе" do
+              interface_obj.foo.should eq('bar')
+            end
+          end
+        end
+        
+        describe "при наследовании" do
+          let(:klass2) { Class.new(klass) }
+          it "должен создавать новый интерфейс-класс, наследуя старый" do
+            klass2.test.ancestors.should include(interface_klass)
+          end
+          it "новый интерфейс-класс должен ссылаться на новый класс" do
+            klass2.test.interface_base.should eq(klass2)
+          end
+        end
+      end
+      
+
+    end
+  end
+
+  describe "Модуль с двумя интерфейсами" do
+    before(:each) do
+      @mod = Module.new
+      @mod.send :extend, RubyInterface
+      @mod.interface :first do
+        interfaced do
+          def baz
+            first.foo
+          end
+        end
+      
+        def foo
+          "bar"
+        end
+      end
+
+      @mod.interface :second do
+        interfaced do
+          self.second_interface.foo
+        end
+
+        def self.foo
+          "baz"
+        end
+      end
+    end
+
+    it "не должно происходить ошибок при подключении модуля с двумя интерфейсами" do
+      b = Class.new
+      lambda { b.send :include, @mod }.should_not raise_error
+    end
+
+    it "должны появиться интерфейсы с методами" do
+      b = Class.new
+      b.send :include, @mod
+      bb = b.new
+      bb.baz.should eq("bar")
+      bb.second_interface.foo.should eq("baz")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rr'
+require 'ruby_interface'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_framework = :rr
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-interface
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
+platform: ruby
+authors: 
+- Andrew Rudenko
+- Nick Recobra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-24 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+description: Ruby interface
+email: ceo@prepor.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-interface/version.rb
+- lib/ruby-interface/yard.rb
+- lib/ruby_interface.rb
+- ruby-interface.gemspec
+- spec/ruby_interface_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1341302791609239659
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby interface
+test_files: 
+- spec/ruby_interface_spec.rb
+- spec/spec_helper.rb