shadydb 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jdpace
+
+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,60 @@
+# ShadyDB
+
+ShadyDB is a document persistence layer that speaks ActiveModel.
+Like it's name says it is _shady_ and is **merely impersonating a database**.
+Its saves records/documents to the file system as XML or JSON files.
+
+In general you should use a traditional database for 99.999% of cases. Real databases
+handle this type of thing way better. If you think ShadyDB is really the way to
+go, think again because you're probably mistaken. ShadyDB is just a ActiveRecord like 
+wrapper for the file system and lacks traditional data integrity schemes.
+
+ShadyDB is built on top of ActiveModel and as a result is a great learning tool for
+understanding the modularity and power that ActiveModel brings. I highly encourage
+anyone to spend the time to write their own ORM.
+
+## Usage
+
+    class User < ShadyDB::Document
+    end
+    
+    u = User.new(:name => 'Marshall Mathers')
+    u.new_record? # true
+    u.save # true
+    u.new_record? # false
+    
+    u.name # 'Marshall Mathers'
+    u[:name] # 'Marshall Mathers'
+    
+    u = User.create(:name => 'Eminem')
+    u.new_record? # false
+    
+    
+## Configuration
+
+    ShadyDB.configure do |config|
+      config.data_directory = Rails.root.join('db','shadydb')
+      config.format         = :xml
+    end
+    
+## TODO
+
+* Add an optional encryption layer
+* Add support for collection finders
+* Add support for conditional finders
+* Add simple indexing
+* Add defined fields a la Mongoid
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Jared Pace. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shadydb"
+    gem.summary = %Q{XML/JSON persistence layer that speaks ActiveModel}
+    gem.description = %Q{ORM that persists to file system using either XML or JSON with optional encryption layer.}
+    gem.email = "jared@codewordstudios.com"
+    gem.homepage = "http://github.com/jdpace/shadydb"
+    gem.authors = ["jdpace"]
+    gem.add_dependency "activemodel", '~> 3.0.0.beta3'
+    gem.add_dependency "activesupport", '~> 3.0.0.beta3'
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shadydb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/shadydb/attributes.rb

@@ -0,0 +1,34 @@
+module ShadyDB
+  
+  module Attributes
+    
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :id, :attributes
+      end
+    end
+    
+    def [](key)
+      attributes[key.to_s]
+    end
+    
+    def []=(key, value)
+      attributes[key.to_s] = value
+    end
+    
+    # Used for allowing accessor methods for dynamic attributes.
+    # Pulled from Mongoid
+    def method_missing(name, *args)
+      attr = name.to_s
+      return super unless @attributes.has_key?(attr.reader)
+      if attr.writer?
+        # "args.size > 1" allows to simulate 1.8 behavior of "*args"
+        @attributes[attr.reader] = (args.size > 1) ? args : args.first
+      else
+        @attributes[attr.reader]
+      end
+    end
+    
+  end
+  
+end

data/lib/shadydb/configuration.rb

@@ -0,0 +1,33 @@
+module ShadyDB
+  class Configuration
+    attr_accessor :data_directory, :format
+
+    def initialize
+      @data_directory = '/data/db'
+      @format = :json
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  # Configure ShadyDB someplace sensible,
+  # like config/initializers/shadydb.rb
+  #
+  # @example
+  #   ShadyDB.configure do |config|
+  #     config.data_directory     = Rails.root.join('db','shadydb')
+  #     config.format             = :json
+  #   end
+  
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  
+  def self.configure
+    self.configuration 
+    yield(configuration)
+  end
+end

data/lib/shadydb/document.rb

@@ -0,0 +1,40 @@
+module ShadyDB
+  
+  class Document
+    extend ActiveModel::Callbacks
+    include ActiveModel::Validations
+    include ShadyDB::Attributes
+    include ShadyDB::Persistence
+    include ShadyDB::Finders
+    
+    before_save :validate
+    
+    def initialize(attribs = {})
+      @new_record = true
+      @destroyed = false
+      
+      self.attributes = {}
+      self.attributes = attribs.stringify_keys if attribs.kind_of?(Hash)
+    end
+    
+    def to_model
+      self
+    end
+    
+    def to_param
+      id
+    end
+    
+    def to_key
+      persisted? ? [id] : nil
+    end
+    
+    protected
+    
+      def validate
+        valid?
+      end
+    
+  end
+  
+end

data/lib/shadydb/extensions/string/helpers.rb

@@ -0,0 +1,21 @@
+module ShadyDB
+  
+  module Extensions
+    
+    module String
+      
+      module Helpers
+        def reader
+          writer? ? gsub("=", "") : self
+        end
+
+        def writer?
+          include?("=")
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/shadydb/extensions.rb

@@ -0,0 +1,5 @@
+require 'shadydb/extensions/string/helpers'
+
+class String
+  include ShadyDB::Extensions::String::Helpers
+end

data/lib/shadydb/finders.rb

@@ -0,0 +1,27 @@
+module ShadyDB
+  
+  module Finders
+    
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+    
+    module ClassMethods
+      def find(id)
+        document = self.new
+        document.instance_variable_set('@id', id)
+        
+        return false unless File.exist?(document.path)
+        storage = File.read(document.path)
+        
+        document.send(:restore!, storage)
+        document.instance_variable_set('@new_record', false)
+        document
+      end
+    end
+    
+  end
+  
+end

data/lib/shadydb/persistence.rb

@@ -0,0 +1,117 @@
+module ShadyDB
+  
+  module Persistence
+    extend ActiveSupport::Concern
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::Serializers::Xml
+    
+    def self.included(base)
+      base.class_eval do
+        define_model_callbacks :save, :create, :update, :destroy
+        
+        before_create :ensure_data_directory_exists
+        
+        extend ClassMethods
+      end
+    end
+    
+    module ClassMethods
+      def create(attribs = {})
+        document = new(attribs)
+        document.save && document
+      end
+      
+      def data_directory
+        File.join(ShadyDB.configuration.data_directory, self.model_name.plural)
+      end
+    end
+    
+    def save
+      _run_save_callbacks do
+        create_or_update
+      end
+    end
+    
+    def update_attributes(attribs)
+      @attributes.merge!(attribs.stringify_keys)
+      save
+    end
+    
+    def destroy
+      return false unless persisted?
+      begin
+        File.delete(path)
+        @destroyed = true
+      rescue
+        false
+      end
+    end
+    
+    def persisted?
+      !(new_record? || destroyed?)
+    end
+    
+    def new_record?
+      @new_record
+    end
+    
+    def destroyed?
+      @destroyed
+    end
+    
+    def path
+      File.join(self.class.data_directory, @id)
+    end
+    
+    protected
+    
+      def ensure_data_directory_exists
+        self.class.data_directory.split('/').inject do |base, dir_name|
+          dir = File.join(base, dir_name)
+          Dir.mkdir(dir) unless File.exist?(dir)
+          dir
+        end
+      end
+    
+      def create_or_update
+        persisted? ? update : create
+      end
+      
+      def create        
+        _run_create_callbacks do
+          @id = generate_id
+          persist!
+          @new_record = false
+          
+          true
+        end
+      end
+      
+      def update
+        _run_update_callbacks do
+          File.open(path,'w') do |storage|
+            storage << self.to_xml
+          end
+          
+          true
+        end
+      end
+      
+      def persist!
+        File.open(path,'w') do |storage|
+          storage << self.send(:"to_#{ShadyDB.configuration.format}")
+        end
+      end
+      
+      def restore!(xml_or_json)
+        send(:"from_#{ShadyDB.configuration.format}" ,xml_or_json)
+      end
+      
+      # TODO: should check if ID is already taken
+      def generate_id
+        ActiveSupport::SecureRandom.hex()
+      end
+      
+  end
+  
+end

data/lib/shadydb.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'active_support'
+require 'active_model'
+require 'shadydb/configuration'
+require 'shadydb/extensions'
+require 'shadydb/attributes'
+require 'shadydb/persistence'
+require 'shadydb/finders'
+require 'shadydb/document'

data/shadydb.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shadydb}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jdpace"]
+  s.date = %q{2010-05-17}
+  s.description = %q{ORM that persists to file system using either XML or JSON with optional encryption layer.}
+  s.email = %q{jared@codewordstudios.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/shadydb.rb",
+     "lib/shadydb/attributes.rb",
+     "lib/shadydb/configuration.rb",
+     "lib/shadydb/document.rb",
+     "lib/shadydb/extensions.rb",
+     "lib/shadydb/extensions/string/helpers.rb",
+     "lib/shadydb/finders.rb",
+     "lib/shadydb/persistence.rb",
+     "shadydb.gemspec",
+     "test/attributes_test.rb",
+     "test/configuration_test.rb",
+     "test/document_test.rb",
+     "test/finders_test.rb",
+     "test/helper.rb",
+     "test/persistence_test.rb"
+  ]
+  s.homepage = %q{http://github.com/jdpace/shadydb}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{XML/JSON persistence layer that speaks ActiveModel}
+  s.test_files = [
+    "test/attributes_test.rb",
+     "test/configuration_test.rb",
+     "test/document_test.rb",
+     "test/finders_test.rb",
+     "test/helper.rb",
+     "test/persistence_test.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
+      s.add_runtime_dependency(%q<activemodel>, ["~> 3.0.0.beta3"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0.beta3"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<activemodel>, ["~> 3.0.0.beta3"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0.beta3"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activemodel>, ["~> 3.0.0.beta3"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0.beta3"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/test/attributes_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class AttributesTest < Test::Unit::TestCase
+  
+  subject do
+    @subject = ShadyDB::Document.new
+  end
+  
+  context "Supporting hash-like interface for attributes" do
+    should "allow reading attributes via []" do
+      document = ShadyDB::Document.new :first_name => 'John', :last_name => 'Locke'
+      assert document[:first_name] == 'John'
+    end
+    
+    should "allow setting attribures via []=" do
+      document = ShadyDB::Document.new
+      document[:name] = 'Jack Shepard'
+      assert document.attributes['name'] == 'Jack Shepard'
+    end
+  end
+  
+  context "Treating attribute keys like top level methods" do
+    should "support top level methods for reading attributes" do
+      document = ShadyDB::Document.new :first_name => 'John', :last_name => 'Locke'
+      assert document.first_name == 'John'
+    end
+    
+    should 'support top level methods for setting attributes' do
+      document = ShadyDB::Document.new :name => 'Hugo'
+      document.name = 'Jack Shepard'
+      assert document.attributes['name'] == 'Jack Shepard'
+    end
+  end
+  
+end

data/test/configuration_test.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class ConfigurationTest < Test::Unit::TestCase
+  
+  context "Configuration" do
+    should "have defaults" do
+      config = ShadyDB::Configuration.new
+      assert config.data_directory
+      assert config.format
+    end
+    
+    should "be accessible from ShadyDB.configuration" do
+      assert ShadyDB.configuration.kind_of?(ShadyDB::Configuration)
+    end
+    
+    should "be configurable" do
+      original_config = ShadyDB.configuration
+      ShadyDB.configuration = ShadyDB::Configuration.new
+      ShadyDB.configure do |config|
+        config.data_directory = '/shadydb'
+        config.format = :xml
+      end
+      
+      assert ShadyDB.configuration.data_directory == '/shadydb'
+      assert ShadyDB.configuration.format == :xml
+      
+      ShadyDB.configuration = original_config
+    end
+  end
+  
+end

data/test/document_test.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class DocumentTest < Test::Unit::TestCase
+  include ActiveModel::Lint::Tests
+  
+  def setup
+    @model = ShadyDB::Document.new
+  end
+end

data/test/finders_test.rb

@@ -0,0 +1,16 @@
+require 'helper'
+
+class FindersTest < Test::Unit::TestCase
+  
+  context "Finding a document by its ID" do
+    should "load the document exactly as it was saved" do
+      original = ShadyDB::Document.create :name => 'Sawyer'
+      found = ShadyDB::Document.find original.id
+      
+      assert found.id == original.id
+      assert found.name == original.name
+      assert found.attributes == original.attributes
+    end
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'shadydb'
+
+class Test::Unit::TestCase
+  
+  def teardown
+    purge_documents
+  end
+  
+  def purge_documents
+    FileUtils.rm_rf(File.join(File.expand_path(File.dirname(__FILE__)), 'db'))
+  end
+  
+end
+
+ShadyDB.configure do |config|
+  config.data_directory = File.join(File.expand_path(File.dirname(__FILE__)), 'db')
+end

data/test/persistence_test.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+class PersistenceTest < Test::Unit::TestCase
+  
+  context "Creating a new document" do
+    should "Save and return a document" do
+      @document = ShadyDB::Document.create :name => 'Dharma Initiative'
+      assert @document.persisted?
+      assert File.exist?(@document.path)
+    end
+  end
+  
+  context "Saving a new document" do
+    setup do
+      @document = ShadyDB::Document.new :name => 'Dharma Initiative'
+    end
+    
+    should "save the document to the file system" do
+      assert @document.save
+      assert File.exist?(@document.path)
+    end
+  end
+  
+  context "Saving an existing document" do
+    setup do
+      @document = ShadyDB::Document.create :name => 'Dharma Initiative'
+      @before = File.new(@document.path).atime
+    end
+    
+    should "update the document on the file system" do
+      assert @document.save
+      assert File.new(@document.path).atime >= @before
+    end
+  end
+  
+  context "Updating an existing document" do
+    setup do
+      @document = ShadyDB::Document.create :name => 'Dharma Initiative'
+      @before = File.new(@document.path).atime
+    end
+    
+    should "update the attributes" do
+      assert @document.update_attributes :location => 'The Island'
+      assert @document.location == 'The Island'
+    end
+    
+    should "update the document on the file system" do
+      assert @document.update_attributes :location => 'The Island'
+      assert File.new(@document.path).atime >= @before
+    end
+  end
+  
+  context "Destroying a document" do
+    setup do
+      @document = ShadyDB::Document.create :name => 'Dharma Initiative'
+    end
+    
+    should "remove the document from the file system" do
+      assert @document.destroy
+      assert !File.exist?(@document.path)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: shadydb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- jdpace
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: ORM that persists to file system using either XML or JSON with optional encryption layer.
+email: jared@codewordstudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/shadydb.rb
+- lib/shadydb/attributes.rb
+- lib/shadydb/configuration.rb
+- lib/shadydb/document.rb
+- lib/shadydb/extensions.rb
+- lib/shadydb/extensions/string/helpers.rb
+- lib/shadydb/finders.rb
+- lib/shadydb/persistence.rb
+- shadydb.gemspec
+- test/attributes_test.rb
+- test/configuration_test.rb
+- test/document_test.rb
+- test/finders_test.rb
+- test/helper.rb
+- test/persistence_test.rb
+has_rdoc: true
+homepage: http://github.com/jdpace/shadydb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: XML/JSON persistence layer that speaks ActiveModel
+test_files: 
+- test/attributes_test.rb
+- test/configuration_test.rb
+- test/document_test.rb
+- test/finders_test.rb
+- test/helper.rb
+- test/persistence_test.rb