hanswurst 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem 'couch_potato'
+group :development do
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem 'mocha'
+  gem "shoulda", ">= 0"
+  
+  gem 'linecache19' 
+  gem 'ruby-debug19' 
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Marc Rene Arns
+
+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,87 @@
+hanswurst: Be a couch potato and play different roles
+=====================
+
+Hanswurst is a library that uses couch potato to create arbitrary
+objects that may have different roles. The roles determine the
+properties and they can be mixed and matched at will.
+
+Hanswurst is only tested with ruby 1.9.2 and above.
+
+Example:
+--------
+
+first you have to build your roles as normal couch potato classes 
+
+    class Person
+      include CouchPotato::Persistence
+
+      property :last_name
+      property :first_name
+
+      validates_presence_of :last_name
+    end
+
+    class Product
+      include CouchPotato::Persistence
+
+      property :price
+      property :in_stock
+    end
+
+then you may use them as you like
+
+    hw = Hanswurst.new
+    hw.add_role Person
+    hw.add_role Product
+
+    hw.person___first_name = 'Diederich'
+    hw.person___last_name = 'Hessling' # an RoleNotValid error is raised if person___last_name is missing
+      
+    # this is also possible
+    hw.product = Product.new :price => 20, :in_stock => 1  
+
+    id = CouchPotato.database.save_document hanswurst
+
+later...
+
+    hw = CouchPotato.database.load_document id
+
+    hw.person___first_name  # => 'Diederich'
+    hw.product___price       # => 20
+
+
+All views are attached to the hanswurst design document
+You may create general views:
+
+    Hanswurst.view :all, :key => :created_at
+
+or views specific for a role
+
+    Hanswurst.view_for :person, :all, :key => :created_at
+
+    # execute them this way
+    CouchPotato.database.view Hanswurst.person_all
+
+the same works with lists.
+
+You may subclass Hanswurst to do further separation and mix the
+native properties of Hanswursts / its subclasses with the roles properties.
+
+
+Contributing to hanswurst
+-------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2012 Marc Rene Arns. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+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'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hanswurst"
+  gem.homepage = "http://github.com/metakeule/hanswurst"
+  gem.license = "MIT"
+  gem.summary = %Q{Be a couch potato and play different roles}
+  gem.description = %Q{flexible enhancement of couch potato}
+  gem.email = "Base64.decode64('bGludXhAbWFyY3JlbmVhcm5zLmRl\n')"
+  gem.authors = ["Marc Rene Arns"]
+  gem.add_runtime_dependency 'couch_potato'
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hanswurst.rb

@@ -0,0 +1,176 @@
+require 'couch_potato'
+
+# Each Hanswurst may have a different combination of roles. It's a very flexible way to be a couch potato.
+class Hanswurst
+
+  # error raised when a role is not valid
+  class RoleNotValid < Exception
+    def initialize(role, value)
+      @role = role
+      @value = value
+    end
+
+    def message()
+      errors = @value.errors.messages.collect do |field, err|
+        "#{field} #{err.join('/')}"
+      end.join(" # ")
+      "role not valid #{@role}: #{errors}"
+    end
+  end
+
+  # class methods for Hanswurst
+  module ClassMethods
+
+    # get class obj from a classname
+    def getClass(classname)
+      classname.split('::').inject Kernel do |c,name| c = c.const_get name; end
+    end
+
+    # creates a view to show only documents of the role +role_alias+ 
+    def role_view(role_alias, viewname, options)
+      # I keep this commented out to inform the reader that we don't want this in order to easily reuse general lists
+      #options[:list] &&= :"#{role_alias}_#{options[:list]}"
+      options[:conditions] &&= " && ( #{options[:conditions]} )"
+      options[:conditions] = "(doc.roles.#{role_alias} !== undefined)#{options[:conditions]}"
+      self.view :"#{role_alias}_#{viewname}", options
+    end
+
+    alias :view_for :role_view
+
+    # creates a list for documents of the role +role_alias+ 
+    def role_list(role_alias, listname, val)
+      self.list :"#{role_alias}_#{listname}", val.to_s
+    end
+
+    alias :list_for :role_list
+
+    # shortcuts view_for_[role], list_for_[role]
+    def method_missing(meth, *args, &code)
+      case meth
+      when /^view_for_(.+)$/
+        send(:view_for, $1, *args)
+      when /^list_for_(.+)$/
+        send(:list_for, $1, *args)
+      else
+        super
+      end
+    end
+  end
+  
+  extend ClassMethods
+
+  include CouchPotato::Persistence
+
+  module MethodMissing
+    # dispatches self.role___prop calls and self.role= setters
+    def method_missing(meth, *args, &code)
+      value = args.first
+      case meth
+      when /^([^=]+)___([^=]+)(\=)?$/ # obj.role__prop # => we get / set a property
+        role, property, setter = $1, $2, $3
+        return setter ? set_property(role, property, value) : read(role, property)
+      when /^([^=]+)\=$/ # obj.role = ... # => we set a role
+        return set_role(role, value) if role_exists?(role=$1)
+      end
+      super
+    end
+  end
+
+  property :roles
+  property :data
+
+  # check if every role is valid before saving
+  before_save do
+    self.data.each do |role,val|
+      unless val.valid?
+        raise RoleNotValid.new(role, val)
+      end
+    end
+  end
+
+  include MethodMissing
+
+  # add a role
+  def add_role(role, klass)
+    add_roles(role => klass)
+  end
+
+  # add more roles at once
+  def add_roles(hsh)
+    self.data ||= {} 
+    r = self.roles || {}
+    hsh.each do |role,klass|
+      raise "class expected: #{klass.inspect}" unless klass.is_a? Class
+      r.update(role.to_s => klass.name)
+    end
+    self.roles = r
+  end
+
+  # does he have a role
+  def role_exists?(role)
+    self.roles and self.roles[role.to_s]
+  end
+
+  # does he have data for the role
+  def data_exists?(role)
+    self.data and self.data[role.to_s]
+  end
+
+  # set a property of a role
+  def set_property(role, property, value)
+    return unless role_exists? role
+    create(role) unless data_exists? role
+    update role, property, value
+  end
+
+  # set a role
+  def set_role(role, value)
+    value ? set(role, value) : delete_role(role)
+  end
+
+  # delete a role
+  def delete_role(role)
+    delete role # delete the data
+    self.roles.delete role.to_s # and the role itself
+  end
+
+  # set instance for a role
+  def set(role, val)
+    self.data ||= {}
+    self.data.update role.to_s => val
+  end
+
+  # create a new instance of a role
+  def create(role)
+    raise "unknown role #{role.inspect}" unless role_exists? role.to_s
+    self.data ||= {}
+    self.data[role.to_s] = self.class.getClass(self.roles[role.to_s]).new
+  end
+
+  # delete a role
+  def delete(role)
+    self.data ||= {}
+    hsh = self.data
+    hsh.delete(role.to_s)
+    self.data = {} # we have to do this, otherwise it won't save?!
+    self.data = hsh
+  end
+
+  # read a property of a role
+  def read(role, property)
+    return self.data[role.to_s].send(property.to_sym) if data_exists?(role.to_s)
+    nil
+  end
+
+  # update a property of a role
+  # we have to use this method in order to make sure that everything is saved
+  def update(role, property, value)
+    if data_exists? role
+      self.data[role.to_s].send(:"#{property}=", value)
+      hsh = self.data.merge(role.to_s => self.data[role.to_s])
+      self.data = {} # we have to do this, otherwise it won't save?!
+      self.data = hsh
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,19 @@
+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 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hanswurst'
+
+
+

data/test/test_hanswurst.rb

@@ -0,0 +1,165 @@
+require 'helper'
+require 'hanswurst'
+
+CouchPotato::Config.database_name = ENV['COUCH_POTATO_TEST_DB']
+
+
+class Pers
+  include CouchPotato::Persistence
+  property :firstname
+  property :lastname
+end
+
+class Prod
+  include CouchPotato::Persistence
+
+  property :article_number
+  property :name
+
+  validates_presence_of :name
+end
+
+module Thing
+  class A 
+    include CouchPotato::Persistence
+    property :a
+  end
+end
+
+Hanswurst.list_for :pers, :complete_name, %q|
+function(head, req) {
+  var row;
+  var rows = [];
+  send('{"rows": ');
+  while(row = getRow()) {
+    row.doc.data.q = req.query;
+    if(req.query["startkey_docid"] && row.doc.data.pers.firstname == req.query["startkey_docid"]){
+      row.doc.data.pers.complete_name = row.doc.data.pers.firstname + ' ' + row.doc.data.pers.lastname;
+      rows[rows.length] = row;
+    }    
+  };
+  send(JSON.stringify(rows));
+  send('}');
+}
+|
+
+Hanswurst.view_for :pers, :all_names, :list => :pers_complete_name #, :raw => true
+
+
+
+class TestCouch < Test::Unit::TestCase
+
+  def recreate_db
+    CouchPotato.couchrest_database.recreate!
+  end
+
+  def save(doc)
+    CouchPotato.database.save_document doc
+  end
+
+  def save!(doc)
+    CouchPotato.database.save_document! doc
+  end
+
+  def load(id)
+    CouchPotato.database.load_document id
+  end
+
+  def view(v)
+    CouchPotato.database.view v
+  end
+
+  def update(id)
+    doc = load id
+    yield doc
+    save doc
+  end
+
+  context "in a real couch" do
+    setup do
+      recreate_db()
+    end
+
+    should "save stuff" do
+      o = Hanswurst.new
+      o.add_role 'person', Pers
+      o.add_role 'product', Prod
+      o.product = Prod.new( :article_number => 'xyz', :name => 'prod1' )
+      o.person = Pers.new( :firstname => 'Donald', :lastname => 'Duck' ) 
+      save o
+      o = load(o._id)      
+      roles = {'person' => 'Pers', 'product' => 'Prod'}
+      assert_equal roles, o.roles
+      assert_equal 'prod1', o.data["product"].name
+      assert_equal 'Donald', o.data["person"].firstname
+      assert_equal 'Donald', o.person___firstname
+    end
+
+    should "save roles" do
+      o = Hanswurst.new
+      o.add_role 'person', Pers
+      o.add_role 'product', Prod
+      o.product___article_number = "abc"
+      o.product___name =  "prod1"
+      o.person___firstname = "Bugs"
+      o.person___lastname = "Bunny"
+      save o
+      o = load(o._id)
+      roles = {'person' => 'Pers', 'product' => 'Prod'}
+      assert_equal roles, o.roles
+      assert_equal 'Bugs', o.person___firstname
+      assert_equal 'Bunny', o.person___lastname
+      assert_equal 'abc', o.product___article_number
+
+      o.product___article_number = "cde"
+      save o
+      o = load(o._id)
+      assert_equal 'prod1', o.product___name
+      assert_equal 'Bugs', o.person___firstname
+      assert_equal 'cde', o.product___article_number
+
+      o.product = nil
+      save o
+      o = load(o._id)
+      assert_equal nil, o.product___name
+      assert !o.roles.has_key?("product")
+      assert_equal 'Bugs', o.person___firstname
+      assert_equal nil, o.product___article_number
+    end
+
+    should "save for moduled classed" do
+      o = Hanswurst.new
+      o.add_role 'thing', Thing::A
+      o.thing___a = "hiho"
+      save o
+      o = load(o._id)
+      roles = {'thing' => 'Thing::A'}
+      assert_equal roles, o.roles
+      assert_equal 'hiho', o.thing___a
+    end
+
+
+    should "not save when validation fails" do
+      o = Hanswurst.new
+      o.add_role 'product', Prod
+      o.product = Prod.new( :article_number => 'xyz')
+      assert_raises Hanswurst::RoleNotValid do
+        save o
+      end
+    end
+
+    should "make a view with list" do
+      o = Hanswurst.new
+      o.add_role 'pers', Pers
+      o.pers = Pers.new :firstname => "Donald", :lastname => "Duck"
+      save o
+      a = Hanswurst.new
+      a.add_role 'pers', Pers
+      a.pers = Pers.new :firstname => "Mickey", :lastname => "Mouse"
+      save a
+      assert_equal "Donald Duck", view(Hanswurst.pers_all_names(:startkey_docid => "Donald")).first.data["pers"].complete_name
+      assert_equal "Donald", view(Hanswurst.pers_all_names(:startkey_docid => "Donald")).first.data["pers"].firstname
+    end
+  end
+
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: hanswurst
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marc Rene Arns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: couch_potato
+  requirement: &27122780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *27122780
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &27122300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *27122300
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &27097640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *27097640
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &27097060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *27097060
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &27096480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *27096480
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &27095960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *27095960
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &27095360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *27095360
+- !ruby/object:Gem::Dependency
+  name: linecache19
+  requirement: &27094800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *27094800
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &27094320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *27094320
+- !ruby/object:Gem::Dependency
+  name: couch_potato
+  requirement: &27093760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *27093760
+description: flexible enhancement of couch potato
+email: ! 'Base64.decode64(''bGludXhAbWFyY3JlbmVhcm5zLmRl
+
+  '')'
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/hanswurst.rb
+- test/helper.rb
+- test/test_hanswurst.rb
+homepage: http://github.com/metakeule/hanswurst
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -565794256545933132
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Be a couch potato and play different roles
+test_files:
+- test/helper.rb
+- test/test_hanswurst.rb