tyrion 0.1.0

data/.gitignore

@@ -0,0 +1,24 @@
+.DS_Store?
+.DS_Store
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Rails
+coverage
+rdoc
+tmp
+pkg
+*.gem
+*.rbc
+lib/bundler/man
+spec/reports
+.config
+.bundle
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - ree
+  - rbx
+  - rbx-2.0
+  - jruby
+
+script: 'bundle exec rspec spec'

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Federico Ravasio
+
+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.markdown

@@ -0,0 +1,64 @@
+# Tyrion [![Build Status](http://travis-ci.org/razielgn/tyrion.png)](http://travis-ci.org/razielgn/tyrion)
+
+A small JSON ODM.
+
+## Goal
+
+Tyrion's goal is to provide a fast (as in _easy to setup_) and dirty unstructured document store.
+
+## Usage
+### Connection
+Tyrion uses a folder to store JSON files, one for each Tyrion document defined.
+Each file is an array of homogeneous documents (much like collections).
+
+``` ruby
+  Tyrion::Connection.path = "/a/folder"
+```
+
+### Document
+``` ruby
+  class Post
+    include Tyrion::Document
+  
+    field :title
+    field :body
+    field :rank
+  end
+```
+
+### Persistence
+#### Save
+``` ruby
+  post = Post.create :title => "Hello", :body => "Hi there, ..."
+  post.save
+```
+``` ruby
+  # Insta-save with !
+  Post.create! :title => "Hello", :body => "Hi there, ..."
+```
+
+#### Delete
+``` ruby
+  post = Post.create :title => "Hello", :body => "Hi there, ..."
+  post.delete
+```
+``` ruby
+  Post.delete_all # You get the idea
+```
+``` ruby
+  Post.delete :title => /^Hello/
+```
+
+### Querying
+`find_by_attribute`: just the first match
+
+``` ruby
+  Post.find_by_title "Hello"
+  Post.find_by_body /^Hi there/i
+```
+
+`where`: all matching documents
+
+``` ruby
+  Post.where :title => /^Hello/, :rank => 3
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+
+desc 'Generate documentation'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', 'LICENSE']
+  t.options = ['--main', 'README.markdown', '--no-private']
+end

data/lib/tyrion/attributes.rb

@@ -0,0 +1,44 @@
+module Tyrion
+  module Attributes
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def field(name, type = String)
+        name = name.to_s
+        
+        define_method("#{name}"){ attributes[name] }
+        define_method("#{name}="){ |value| attributes[name] = value }
+      end
+    end
+    
+    module InstanceMethods
+      attr_reader :attributes
+      
+      def initialize
+        super
+        @attributes = {}
+      end
+      
+      def method_missing(name, *args)
+        attr = name.to_s
+        return super unless attributes.has_key? attr.gsub("=", "")
+        
+        if attr =~ /=$/
+          write_attribute(attr[0..-2], args.shift || raise("BOOM"))
+        else
+          read_attribute(attr)
+        end
+      end
+      
+      protected
+      
+      def read_attribute(name)
+        attributes[name.to_s]
+      end
+      
+      def write_attribute(name, arg)
+        attributes[name.to_s] = arg
+      end
+    end
+  end
+end

data/lib/tyrion/components.rb

@@ -0,0 +1,10 @@
+module Tyrion
+  module Components
+    extend ActiveSupport::Concern
+    
+    include Tyrion::Attributes
+    include Tyrion::Persistence
+    include Tyrion::Querying
+    include Tyrion::Storage
+  end
+end

data/lib/tyrion/connection.rb

@@ -0,0 +1,13 @@
+module Tyrion
+  module Connection
+    extend self
+    
+    def path= folder_path
+      @folder_path = folder_path
+    end
+    
+    def path
+      @folder_path || raise("No path set!")
+    end
+  end
+end

data/lib/tyrion/document.rb

@@ -0,0 +1,34 @@
+module Tyrion
+  
+  # Base module to persist objects.
+  module Document
+    extend ActiveSupport::Concern
+    include Tyrion::Components
+    
+    module ClassMethods
+      protected
+      
+      def klass_name
+        to_s.downcase
+      end
+    end
+    
+    module InstanceMethods
+      
+      # Checks for equality.
+      # @example Compare two objects
+      #   object == other
+      # @param [Object] The other object to compare with
+      # @return [true, false] True if objects' attributes are the same, false otherwise.
+      def == other
+        other.attributes == attributes
+      end
+      
+      private
+      
+      def klass_name
+        self.class.to_s.downcase
+      end
+    end
+  end
+end

data/lib/tyrion/persistence.rb

@@ -0,0 +1,37 @@
+module Tyrion
+  module Persistence
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def create attributes = {}
+        new.tap do |n|
+          attributes.each_pair{ |k, v| n.send(:write_attribute, k.to_s, v) }
+        end
+      end
+      
+      def create! attributes = {}
+        create(attributes).tap{ |doc| doc.save }
+      end
+      
+      def delete_all
+        storage[klass_name].clear
+      end
+      
+      def delete attributes = {}
+        where(attributes).each(&:delete)
+      end
+    end
+    
+    module InstanceMethods
+      def save
+        self.class.storage[klass_name] << self
+        self.class.save_storage klass_name
+      end
+      
+      def delete
+        self.class.storage[klass_name].delete_if{ |doc| self == doc }
+        self.class.save_storage klass_name
+      end
+    end
+  end
+end

data/lib/tyrion/querying.rb

@@ -0,0 +1,51 @@
+module Tyrion
+  module Querying
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def all
+        storage[klass_name].dup
+      end
+      
+      def where attributes = {}
+        all.map do |doc|
+          match = attributes.each_pair.map do |k, v|
+            operator = if v.is_a? Regexp
+              :=~
+            else
+              :==
+            end
+            
+            true if doc.send(:read_attribute, k.to_s).send(operator, v)
+          end.compact
+          
+          doc if match.count == attributes.count
+        end.compact
+      end
+      
+      def method_missing(method, *args)
+        if method.to_s =~ /^find_by_(.+)$/
+          attr = $1
+          arg = args.shift || raise("Provide at least one argument!")
+          
+          all.each do |doc|
+            operator = if arg.is_a? Regexp
+              :=~
+            else
+              :==
+            end
+            
+            return doc if doc.attributes[attr].send(operator, arg)
+          end
+          
+          nil
+        else
+          super
+        end
+      end
+    end
+  
+    module InstanceMethods
+    end
+  end
+end

data/lib/tyrion/storage.rb

@@ -0,0 +1,46 @@
+module Tyrion
+  module Storage    
+    extend ActiveSupport::Concern
+        
+    included do
+      reload unless self == Tyrion::Components
+    end
+    
+    module ClassMethods
+      def storage
+        @storage ||= {}
+      end
+    
+      def reload
+        klass_name = to_s.downcase
+        path = klass_filepath klass_name
+        
+        if File.exists?(path)
+          raw_file = File.read(path)
+          storage[klass_name] = MultiJson.decode(raw_file).map{ |doc| create doc }
+        else
+          storage[klass_name] = []
+        end
+      end
+    
+      def save_storage klass_name
+        path = klass_filepath klass_name
+        
+        File.open(path, 'w') do |f|
+          f.puts MultiJson.encode(storage[klass_name].map &:attributes)
+        end
+        
+        true
+      end
+      
+      protected
+      
+      def klass_filepath klass_name
+        File.join(Connection.path, klass_name + ".json")
+      end
+    end
+    
+    module InstanceMethods
+    end
+  end
+end

data/lib/tyrion/version.rb

@@ -0,0 +1,3 @@
+module Tyrion #:nodoc:
+  VERSION = '0.1.0'
+end

data/lib/tyrion.rb

@@ -0,0 +1,13 @@
+require 'multi_json'
+require 'active_support'
+
+require 'tyrion/version'
+require 'tyrion/connection'
+
+require 'tyrion/attributes'
+require 'tyrion/persistence'
+require 'tyrion/querying'
+require 'tyrion/storage'
+require 'tyrion/components'
+
+require 'tyrion/document'

data/spec/connection_spec.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+describe Tyrion::Connection do
+  before{ @original_path = subject.path }  
+  after{ subject.path = @original_path }
+  
+  describe '.path' do
+    it 'should raise an exception if no path is set' do
+      expect do
+        subject.path = nil
+        subject.path
+      end.to raise_exception
+    end
+  end
+  
+  describe '.path=' do
+    it 'should set the path correctly' do
+      subject.path = ENV['HOME']
+      subject.path.should == ENV['HOME']
+    end
+  end
+end

data/spec/document_spec.rb

@@ -0,0 +1,133 @@
+require 'test_helper'
+require 'examples/post'
+
+describe Tyrion::Document do
+   
+  let! :yml_posts do
+    YAML.load_file File.join(File.dirname(__FILE__), 'fixtures', 'posts.yml')
+  end
+  
+  before :each do
+    Post.reload
+    
+    yml_posts.each do |p|
+      Post.create! p
+    end
+  end
+  
+  it 'should survive a reload' do
+    Post.reload
+    Post.all.count.should == yml_posts.count
+  end
+  
+  describe ".create" do
+    it 'should create a new instance with given attributes' do
+      post = Post.create :title => "Title", :body => "Body"
+      post.title.should == "Title"
+      post.body.should == "Body"
+    end
+  end
+  
+  describe ".all" do
+    it 'should find three posts' do
+      Post.all.count.should == yml_posts.count
+    end
+  end
+  
+  describe ".find_by_" do
+    context "when performing the search without a regexp" do
+      it "should return a single value" do
+        search = Post.find_by_title("Hello")
+        search.should_not be_nil
+        search.should_not be_a(Array)
+      end
+      
+      it 'should return the first document found' do
+        search = Post.find_by_rank(2)
+        search.title.should == "Testing"
+      end
+      
+      it "should return nil if nothing is found" do
+        Post.find_by_title(5).should be_nil
+      end
+    end
+    
+    context "when performing the search with a regexp" do
+      it "should return a single value" do
+        search = Post.find_by_title(/Hello/).should_not be_nil
+        search.should_not be_nil
+        search.should_not be_a(Array)
+      end
+      
+      it "should return nil if nothing is found" do
+        Post.find_by_title(/^u/).should be_nil
+      end
+    end
+    
+    it 'should raise an exception if the search is performed without arguments' do
+      expect do
+        Post.find_by_body
+      end.to raise_exception
+    end
+    
+    it 'should raise an exception if the search is performed on an unknown attribute' do
+      expect do
+        Post.find_by_id
+      end.to raise_exception
+    end
+  end
+  
+  describe ".remove_all" do
+    it 'should delete every document' do
+      Post.delete_all
+      Post.all.count.should == 0
+    end
+  end
+  
+  describe ".remove" do
+    it "should remove all matching documents" do
+      criteria = { :rank => 2, :body => /!$/ }
+      Post.delete(criteria)
+      Post.where(criteria).should be_empty
+    end
+  end
+  
+  describe ".where" do
+    it 'should return an array on matching documents' do
+      search = Post.where(:rank => 2, :body => /!$/)
+      search.should_not be_nil
+      search.should be_a(Array)
+      search.count.should == 2
+    end
+
+    it 'shoudl return an empty array if no documents are matched' do
+      Post.where(:title => /e/, :body => /^A/, :rank => 9000).should be_empty
+    end
+  end
+  
+  describe "#save" do
+    it 'should save a new document' do
+      post = Post.new
+      post.title = "Title"
+      post.body = "Body"
+      post.save.should be_true
+    end
+  end
+  
+  describe "#method_missing" do
+    it 'should allow to read and update new attributes' do
+      post = Post.new
+      post.send :write_attribute, :comments, 1
+      post.comments.should == 1
+      post.comments = 2
+      post.comments.should == 2
+    end
+  end
+  
+  describe "#delete" do
+    it 'should remove the document' do
+      Post.find_by_title("Hello").delete
+      Post.find_by_title("Hello").should be_nil
+    end
+  end
+end

data/spec/examples/post.rb

@@ -0,0 +1,7 @@
+class Post
+  include Tyrion::Document
+  
+  field :rank
+  field :title
+  field :body
+end

data/spec/fixtures/posts.yml

@@ -0,0 +1,10 @@
+---
+- title: Hello
+  body: "Hi there, this is my new blog!"
+  rank: 1
+- title: Testing
+  body: "Just testing some stuff around!"
+  rank: 2
+- title: An idea
+  body: "I've got an idea, lemme try something!"
+  rank: 2

data/spec/test_helper.rb

@@ -0,0 +1,24 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'tmpdir'
+require 'fileutils'
+
+require 'tyrion'
+
+tmpdir = Dir.mktmpdir
+Tyrion::Connection.path = tmpdir
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Tyrion::Connection.path = Dir.mktmpdir
+  end
+  
+  config.after(:each) do
+    FileUtils.rm_rf Tyrion::Connection.path
+  end
+  
+  config.after(:suite) do
+    FileUtils.rm_rf tmpdir
+  end
+end

data/tyrion.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tyrion/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tyrion"
+  s.version     = Tyrion::VERSION
+  s.authors     = ["Federico Ravasio"]
+  s.email       = ["ravasio.federico@gmail.com"]
+  s.homepage    = "http://github.com/"
+  s.summary     = %q{Tyrion is a small JSON ODM}
+  s.description = %q{Tyrion's goal is to provide a fast (as in _easy to setup_) and dirty unstructured document store.}
+
+  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 'multi_json'
+  s.add_dependency 'json_pure'
+  s.add_dependency 'active_support'
+  
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: tyrion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Federico Ravasio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-22 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70236571329080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70236571329080
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: &70236571328660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70236571328660
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70236573373400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70236573373400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70236573372980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70236573372980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70236573372560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70236573372560
+description: Tyrion's goal is to provide a fast (as in _easy to setup_) and dirty
+  unstructured document store.
+email:
+- ravasio.federico@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/tyrion.rb
+- lib/tyrion/attributes.rb
+- lib/tyrion/components.rb
+- lib/tyrion/connection.rb
+- lib/tyrion/document.rb
+- lib/tyrion/persistence.rb
+- lib/tyrion/querying.rb
+- lib/tyrion/storage.rb
+- lib/tyrion/version.rb
+- spec/connection_spec.rb
+- spec/document_spec.rb
+- spec/examples/post.rb
+- spec/fixtures/posts.yml
+- spec/test_helper.rb
+- tyrion.gemspec
+has_rdoc: true
+homepage: http://github.com/
+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: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Tyrion is a small JSON ODM
+test_files:
+- spec/connection_spec.rb
+- spec/document_spec.rb
+- spec/examples/post.rb
+- spec/fixtures/posts.yml
+- spec/test_helper.rb