hollybush 0.0.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+ruby-1.9.2-p180/
+.DS_Store

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@hollybush

data/CHANGELOG.markdown

@@ -0,0 +1,4 @@
+# Hollybush Changelog
+
+## 0.0.1 - Initialise providing basic features such as List and Entry management.
+## 0.0.2 - Bug fixes, support for MongoHQ datasource URLs and sharing of an external MongDB database object.

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,18 @@
+# Hollybush
+
+Hollybush is a gem to manage flexible structured lists, using MongoDB as a backing database. Hollybush is 
+intended to be used in a variety of scenarios including outlining tools and todo list managers.
+
+WARNING: This gem is currently under heavy development and subject to a shedload of change. You're best not using it.
+
+## Copyright
+
+(The MIT License)
+
+Copyright © 2010 Ijonas Kisselbach
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require "rubygems"
+require "bundler/setup"
+
+Bundler::GemHelper.install_tasks

data/hollybush.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hollybush/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hollybush"
+  s.version     = Hollybush::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ijonas Kisselbach"]
+  s.email       = ["ijonas.kisselbach@gmail.com"]
+  s.homepage    = "http://github.com/ijonas/hollybush"
+  s.summary     = %q{Flexible structured list manager backed by MongoDB.}
+  s.description = %q{Light-weight flexible structured list implementation.}
+
+  s.rubyforge_project = "hollybush"
+
+  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 "mongo"
+  s.add_dependency "mongo_ext"
+  s.add_dependency "bson"
+  s.add_dependency "bson_ext"
+  s.add_dependency "activemodel"
+  s.add_dependency "activesupport"
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "awesome_print"
+  
+end

data/lib/hollybush.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "bundler/setup"
+
+require "mongo"
+require "active_model"
+require "active_support"
+require "logger"
+
+require File.expand_path(File.join(File.dirname(__FILE__), '/hollybush/connectivity'))
+require File.expand_path(File.join(File.dirname(__FILE__), '/hollybush/list'))

data/lib/hollybush/connectivity.rb

@@ -0,0 +1,23 @@
+module Hollybush
+  unless defined?(@@mongodb) and @@mongodb 
+    if ENV['MONGOHQ_URL']
+      log = Logger.new(STDOUT)
+      log.level = Logger::DEBUG
+
+      uri = URI.parse(ENV['MONGOHQ_URL'])
+      conn = Mongo::Connection.new(uri.host, uri.port)
+      @@mongodb = conn.db(uri.path.gsub(/^\//, ''))
+      @@mongodb.authenticate(uri.user, uri.password) unless uri.user.nil? or uri.user.empty?
+    end
+  end
+  def self.mongodb=(mongodb)
+    @@mongodb = mongodb
+  end
+  def self.mongodb
+    unless defined?(@@mongodb) and @@mongodb 
+      puts "PLEASE SPECIFY A MONGODB DATABASE OBJECT. Use Hollybush.mongodb="
+      return nil
+    end
+    @@mongodb
+  end
+end

data/lib/hollybush/list.rb

@@ -0,0 +1,136 @@
+module Hollybush
+  
+  class List
+    include Enumerable
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+    
+    attr_accessor :id, :name, :entries
+    validates_presence_of :name
+    
+    def initialize(attributes = {})
+      update_attributes(attributes)
+      @entries = [] unless @entries      
+      @id = attributes["_id"].to_s if attributes.include?("_id")
+    end
+    
+    def save
+      if valid?
+        update_doc = {:name => @name, :entries => @entries}
+        if @id
+          List.coll.update({"_id" => make_id(@id)}, update_doc)
+        else
+          @id = List.coll.save(update_doc).to_s
+        end
+      else
+        false
+      end
+    end
+    
+    def self.create(attributes)
+      list = List.new(attributes)
+      list.save
+      list
+    end
+    
+    def each(&a_block)
+      doc = List.coll.find_one({"_id" => @id})
+      doc["entries"].each(&a_block) if doc["entries"] 
+    end
+    
+    def <<(entry)
+      save unless persisted?
+      BSON::ObjectId.create_pk(entry)
+      @entries << entry if List.coll.update({"_id" => make_id(@id)}, {"$push" => {:entries => entry}})
+    end
+    
+    def delete_entry(entry)
+      @entries.delete(entry) if List.coll.update({"_id" => make_id(@id)}, {"$pull" => {:entries => {"_id" => entry["_id"]}}})
+    end
+    
+    def update_entry(entry)
+      entry["_id"] = make_id(entry["_id"])
+      List.coll.update({"_id" => make_id(@id), "entries._id" => entry["_id"]}, {"$set" => {"entries.$"=> entry}})
+    end
+    
+    def persisted?
+      @id != nil
+    end
+    
+    def update_attributes(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value) if respond_to?(name)
+      end      
+    end
+    
+    def delete
+      List.coll.remove({"_id" => make_id(@id)})
+    end
+    
+    def self.delete(query = {})
+      begin
+        List.coll.remove(prepare(query))
+      rescue BSON::InvalidObjectId
+      end
+    end
+
+    def self.delete_entry(query = {})
+      begin
+        List.coll.remove(prepare(query))
+      rescue BSON::InvalidObjectId
+      end
+    end
+
+    
+    def self.find(query = {}, options = {})
+      begin
+        coll.find(prepare(query), options).to_a.map {|doc| Hollybush::List.new(doc)}
+      rescue BSON::InvalidObjectId => e
+        puts e.message
+        []
+      end
+    end
+    
+    def self.count(query = {})
+      coll.find(query, :fields => []).count
+    end
+  
+    private 
+    def make_id(id)
+      BSON::ObjectId.from_string(id)
+    end
+
+    def make_random_id
+      BSON::ObjectId.from_string(id)
+    end
+    
+    def self.coll
+      begin
+        Hollybush.mongodb.collection(:list)        
+      rescue Exception => e
+        puts e.message
+        puts e.backtrace.join("\n")
+      end      
+    end
+
+    def self.prepare(query)
+      ids = ["id", "_id", :id, :_id]
+      new_bson_id = nil
+      # we support querying by various incarnations of 'id' when in actual fact the query should be on '_id', so lets correct that
+      ids.map do |id_key|
+        if query.include?(id_key)
+          new_bson_id = BSON::ObjectId.from_string(query[id_key])
+          query.delete id_key
+        end
+      end
+      query["_id"] = new_bson_id if new_bson_id
+      query
+    end
+    
+    
+  end  
+  
+  
+  
+end

data/lib/hollybush/version.rb

@@ -0,0 +1,3 @@
+module Hollybush
+  VERSION = "0.0.2"
+end

data/spec/list_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+module Hollybush
+  
+  describe List do
+    context "when storing in the DB with valid details" do
+      before(:each) do
+        @list = List.new(:name => "My New List")
+        @list.save
+      end
+      it "should have an id" do
+        @list.id.should_not be_nil
+      end
+      it "id should be of a String type" do
+        @list.id.should be_an_instance_of(String)
+      end
+      it "should have a name" do
+        @list.name.should == "My New List"
+      end
+      specify {@list.should be_valid}      
+      context "when adding items into the list" do
+        before(:each) do
+          @list << {:description => "Here's an item"}
+          @list << {:description => "Here's another item", :state => "Started"}
+        end
+        specify { @list.should have(2).entries }
+        
+        context "when deleting items from the list" do
+          before(:each) do
+            @list.delete_entry(@list.entries.first)
+          end
+          specify { @list.should have(1).entries }
+        end
+        
+        context "when updating an item" do
+          before(:each) do
+            entry = @list.entries.first
+            entry["description"] = "Here's an updated entry"
+            @list.save
+            @updated_list = List.find(:_id => @list.id).first
+          end
+          it "should update an existing entry" do
+            @updated_list.entries.first["description"].should == "Here's an updated entry"
+          end
+          it "should not create or remove Lists" do
+            expect { @list.save }.not_to change(List, :count)
+          end
+          it "should not create or remove Entries in the Lists" do
+            @updated_list.should have(2).entries
+          end
+        end
+      end
+    end
+    
+    context "when storing in the DB with invalid details" do
+      before(:each) do
+        @list = List.new(:name => nil)
+        @list.save
+      end
+      specify {@list.should_not be_valid}
+      it "should have an id" do
+        @list.id.should be_nil
+      end
+      it "should have an error on 'name'" do
+        @list.errors[:name].should == ["can't be blank"]
+      end
+    end
+    
+    context "when updating a List" do
+      before(:each) do
+        @list = List.new(:name => "My New List")
+        @list.save
+      end
+      context "with valid details" do
+        before(:each) do
+          @list.name = "My Revised List"
+          @list.save
+        end
+        specify {@list.should be_valid}
+        it "should persist on save" do
+          List.find({"id" => @list.id}).first.name.should == "My Revised List"
+        end
+      end
+      context "with invalid details" do
+        before(:each) do
+          @list.name = nil
+          @list.save          
+        end
+        specify {@list.should_not be_valid}
+        it "should leave persisted version of List unaffected" do
+          List.find({"id" => @list.id}).first.name.should == "My New List"
+        end
+        it "should have an error on 'name'" do
+          @list.errors[:name].should == ["can't be blank"]
+        end        
+      end
+      context "with an attribute hash" do
+        before(:each) do
+          @list = List.create(:name => "My New List")
+          @attributes = {"name"=>"My Revised Shopping List", "entries" => [{"description"=>"entry 1"},{"description"=>"entry 2"}], "id"=>@list.id, "controller"=>"lists", "action"=>"update"}
+          @list.update_attributes(@attributes)
+          @list.save
+        end
+        specify{ @list.should be_valid }
+        it "should update the persisted version with name and entries" do
+          list = List.find({"id" => @list.id}).first
+          list.name.should == @attributes["name"]
+          list.entries.should =~ @attributes["entries"]
+        end
+      end
+      
+    end
+    
+    context "when retrieving from the DB" do
+      before(:each) do
+        @list = List.new(:name => "My New List", "entries" => [{"description" => "Here's an item"}])
+        @id = @list.save
+        List.new(:name => "My Second List", "entries" => [{"description" => "Here's another item"}]).save
+      end
+      it "should retrieve all lists by specifying no parameters" do
+        List.find.should have(2).entries
+      end
+      it "should retrieve specific lists by specifying some parameters" do
+        List.find("_id" => @id).first.id.should == @list.id
+      end
+    end
+    
+    context "when deleting Lists" do
+      before(:each) do
+        @list1 = List.create(:name => "My first list")
+        @list2 = List.create(:name => "My second list")
+      end
+      context "deleting a single list" do
+        it "should reduce the List count by 1" do
+          expect { @list1.delete }.to change(List, :count).by(-1)
+        end
+      end
+      context "deleting Lists based on matching criteria" do
+        it "should reduce the List count by 2" do
+          expect { List.delete({:name => /My/}) }.to change(List, :count).by(-2)
+        end
+      end
+      context "deleting Lists based on non-matching criteria" do
+        it "should not reduce the List count" do
+          expect { List.delete({:name => /You/}) }.to_not change(List, :count)
+        end
+      end
+    end
+    
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '/../lib/hollybush'))
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Hollybush.mongodb.collections.select { |c| c.name != 'system.indexes' }.each(&:drop)
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: hollybush
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ijonas Kisselbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: awesome_print
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id008
+description: Light-weight flexible structured list implementation.
+email: 
+- ijonas.kisselbach@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- CHANGELOG.markdown
+- Gemfile
+- README.markdown
+- Rakefile
+- hollybush.gemspec
+- lib/hollybush.rb
+- lib/hollybush/connectivity.rb
+- lib/hollybush/list.rb
+- lib/hollybush/version.rb
+- spec/list_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ijonas/hollybush
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: hollybush
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Flexible structured list manager backed by MongoDB.
+test_files: 
+- spec/list_spec.rb
+- spec/spec_helper.rb