grosser-concern 0.2.0

data/README.markdown

@@ -0,0 +1,79 @@
+Seperation of concerns without meta-madness and namespace pollution.  
+
+Normal includes and extensions pollute the namespace and share private/protected.  
+With concern, everything stays in the Concern, can access the concerned and keep namespaced+private.
+
+Install
+=======
+As Gem: ` sudo gem install grosser-concern -s http://gems.github.com `  
+Or as Rails plugin: ` script/plugins install git://github.com/grosser/concern.git `
+
+Usage
+=====
+Normal usage:
+    # a.rb
+    require 'concern'
+    class A
+      concern 'a/acl'
+
+      def admin? ...
+    end
+
+    # a/acl.rb
+    class A::ACL < Concern
+      def can_access?(vault)
+        admin? and secret
+      end
+
+      private
+
+      def secrect ...
+    end
+
+    A.new.acl.can_access?(BankAccount)
+
+Delegate usage:
+
+    class A
+      class Message
+        def write_message ...
+        def read_message ...
+      end
+
+      concern 'a/acl', :delegate => :true # all public
+      concern 'a/messages', :delegate => [:write_message]
+    end
+
+    A.new.can_access?(BankAccount)
+    A.new.write_message
+    A.new.message.read_message
+
+Adding to concerned:
+    class A
+      class B < Concern
+        def initialize
+          super
+          @something = {}
+        end
+
+        def self.included(base)
+          base.class_eval do
+            test
+          end
+        end
+      end
+
+      def self.test
+        puts "it works"
+      end
+
+      concern 'a/b'
+    end
+
+More examples can be found in [spec/examples](http://github.com/grosser/concern/tree/master/spec/examples)
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile.rb

@@ -0,0 +1,20 @@
+desc "Run all specs in spec directory"
+task :default do
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+begin
+  require 'jeweler'
+  project_name = 'concern'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.description = gem.summary = "Seperation of concerns without meta-madness and namespace pollution"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/concern.gemspec

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{concern}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-09-12}
+  s.description = %q{Seperation of concerns without meta-madness and namespace pollution}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile.rb",
+     "VERSION",
+     "concern.gemspec",
+     "init.rb",
+     "lib/concern.rb",
+     "spec/concern_spec.rb",
+     "spec/examples/a/b.rb",
+     "spec/examples/adding.rb",
+     "spec/examples/delegate.rb",
+     "spec/examples/inline.rb",
+     "spec/examples/load.rb",
+     "spec/examples/parent_warning.rb",
+     "spec/examples/picky_delegate.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/concern}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Seperation of concerns without meta-madness and namespace pollution}
+  s.test_files = [
+    "spec/examples/adding.rb",
+     "spec/examples/picky_delegate.rb",
+     "spec/examples/inline.rb",
+     "spec/examples/load.rb",
+     "spec/examples/parent_warning.rb",
+     "spec/examples/delegate.rb",
+     "spec/examples/a/b.rb",
+     "spec/concern_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+#only needed wen used as Rails plugin
+require 'concern'

data/lib/concern.rb

@@ -0,0 +1,59 @@
+class Concern
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+
+  attr_accessor :concerned
+
+  def self.classify(lib)
+    lib.split('/').map{|part| part.capitalize }.join('::')
+  end
+end
+
+class Object
+  def self.concern(lib, options={})
+    # load delegate
+    lib = lib.to_s
+    klass = Concern.classify(lib)
+    begin
+      klass = eval(klass)
+    rescue
+      require lib
+      klass = eval(klass)
+    end
+
+    unless klass.instance_methods.map{|x|x.to_s}.include?('concerned=')
+      raise "A concern must always extend Concern"
+    end
+
+    # make accessor
+    accessor = lib.split('/').last.to_sym
+    eval <<-EOF
+      def #{accessor}
+        return @#{accessor} if @#{accessor}
+        @#{accessor} = #{klass}.new
+        @#{accessor}.concerned = self
+        @#{accessor}
+      end
+    EOF
+
+    # call included
+    base = eval(name) #self.class is always Class, but name is class that called concern
+    klass.included(base) if klass.respond_to? :included
+
+    # delegate methods
+    if options[:delegate]
+      methods = if options[:delegate].is_a?(Array)
+        options[:delegate]
+      else
+        klass.public_instance_methods(false)
+      end
+
+      methods.each do |method|
+        eval <<-EOF
+          def #{method}(*args)
+            #{accessor}.#{method}(*args)
+          end
+        EOF
+      end
+    end
+  end
+end

data/spec/concern_spec.rb

@@ -0,0 +1,25 @@
+describe "Concern" do
+  it "loads the correct file" do
+    `ruby spec/examples/load.rb`.should == "hello"
+  end
+
+  it "can use already present class" do
+    `ruby spec/examples/inline.rb`.should == "inline"
+  end
+
+  it "can delegate" do
+    `ruby spec/examples/delegate.rb`.should == "hello"
+  end
+
+  it "can delegate some" do
+    `ruby spec/examples/picky_delegate.rb`.should == "hello"
+  end
+
+  it "add to parent" do
+    `ruby spec/examples/adding.rb`.should == "yepworld"
+  end
+
+  it "warns when parent is not Concern" do
+    `ruby spec/examples/parent_warning.rb`.should == "SUCCESS"
+  end
+end

data/spec/examples/a/b.rb

@@ -0,0 +1,9 @@
+class A::B < Concern
+  def test
+    'hello'
+  end
+
+  def test2
+    'ohoh'
+  end
+end

data/spec/examples/adding.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH << 'lib' << 'spec/examples'
+require 'concern'
+
+class A
+  class B < Concern
+    def initialize
+      super
+      @hello = 'world'
+    end
+
+    def hello
+      @hello
+    end
+
+    def self.included(base)
+      base.class_eval do
+        test
+      end
+    end
+  end
+
+  def self.test
+    print "yep"
+  end
+
+  concern 'a/b'
+end
+
+print A.new.b.hello

data/spec/examples/delegate.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH << 'lib' << 'spec/examples'
+require 'concern'
+
+class A
+  def xxx
+    'xxx'
+  end
+  concern 'a/b', :delegate=>true
+end
+
+raise if A.new.send(:xxx) != 'xxx'
+print A.new.test

data/spec/examples/inline.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH << 'lib'
+require 'concern'
+
+class A
+  class B < Concern
+    def test
+      'inline'
+    end
+  end
+  concern 'a/b'
+end
+
+print A.new.b.test

data/spec/examples/load.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH << 'lib' << 'spec/examples'
+require 'concern'
+
+class A
+  concern 'a/b'
+end
+
+print A.new.b.test

data/spec/examples/parent_warning.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH << 'lib' << 'spec/examples'
+require 'concern'
+
+class A
+  class B # < Concern
+  end
+
+  begin
+    concern 'a/b'
+    print 'FAIL'
+  rescue
+    raise unless $!.to_s =~ /extend Concern/
+    print 'SUCCESS'
+  end
+end

data/spec/examples/picky_delegate.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH << 'lib' << 'spec/examples'
+require 'concern'
+class A
+  concern 'a/b', :delegate=>[:test]
+end
+
+ok = begin
+  A.new.test2
+  false
+rescue
+  true
+end
+raise unless ok
+print A.new.test

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: grosser-concern
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Seperation of concerns without meta-madness and namespace pollution
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile.rb
+- VERSION
+- concern.gemspec
+- init.rb
+- lib/concern.rb
+- spec/concern_spec.rb
+- spec/examples/a/b.rb
+- spec/examples/adding.rb
+- spec/examples/delegate.rb
+- spec/examples/inline.rb
+- spec/examples/load.rb
+- spec/examples/parent_warning.rb
+- spec/examples/picky_delegate.rb
+has_rdoc: false
+homepage: http://github.com/grosser/concern
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Seperation of concerns without meta-madness and namespace pollution
+test_files: 
+- spec/examples/adding.rb
+- spec/examples/picky_delegate.rb
+- spec/examples/inline.rb
+- spec/examples/load.rb
+- spec/examples/parent_warning.rb
+- spec/examples/delegate.rb
+- spec/examples/a/b.rb
+- spec/concern_spec.rb