stone 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2008-04-15
+
+* Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Nick DeMonner
+
+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/Manifest.txt

@@ -0,0 +1,50 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/stone-gen
+config/hoe.rb
+config/requirements.rb
+lib/stone.rb
+lib/stone/callbacks.rb
+lib/stone/core_ext/string.rb
+lib/stone/core_ext/symbol.rb
+lib/stone/data_store.rb
+lib/stone/query.rb
+lib/stone/resource.rb
+lib/stone/version.rb
+log/debug.log
+sandbox_for_specs/datastore/.stone_metadata
+sandbox_for_specs/datastore/authors/1.yml
+sandbox_for_specs/datastore/authors/2.yml
+sandbox_for_specs/datastore/authors/3.yml
+sandbox_for_specs/datastore/authors/4.yml
+sandbox_for_specs/datastore/authors/5.yml
+sandbox_for_specs/datastore/posts/1.yml
+sandbox_for_specs/datastore/posts/2.yml
+sandbox_for_specs/sample_resources/author.rb
+sandbox_for_specs/sample_resources/comment.rb
+sandbox_for_specs/sample_resources/person.rb
+sandbox_for_specs/sample_resources/post.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/callbacks_spec.rb
+spec/query_spec.rb
+spec/resource_spec.rb
+spec/spec_helper.rb
+spec/stone_spec.rb
+spec/string_spec.rb
+spec/symbol_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+website/images/stone.png
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,52 @@
+= Stone
+
+* stone.rubyforge.org
+
+== DESCRIPTION:
+
+For small applications, a database can be overkill for storing your data in a consistent and
+organized manner. Therefore, Stone was built to provide plug-and-play data persistence for 
+any application or framework. It is fast, and it is easy... it is good.
+
+== PROBLEMS:
+
+* This is the 0.1.0 release so lots and lots of stuff to do.
+
+== SYNOPSIS:
+
+  include Stone::Resource for persistence of any object
+
+== REQUIREMENTS:
+
+* English
+* Facets
+* Validatable
+
+== INSTALL:
+
+* sudo gem install stone
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Nick DeMonner
+
+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,22 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+require "rake"
+require 'fileutils'
+require "rake/clean"
+require "spec/rake/spectask"
+require 'lib/stone'
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end
+
+desc "Run specs"
+task :ok do
+  Stone.empty_datastore
+  FileUtils.rm(Dir.pwd/"sandbox_for_specs"/"stone.sql") \
+    if File.exists? Dir.pwd/"sandbox_for_specs"/"stone.sql"
+  sh "rake specs"
+end

data/bin/stone-gen

@@ -0,0 +1,70 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+require 'rubygems'
+require 'facets'
+
+def usage
+  puts <<-EOS
+  
+  
+    stone-gen model
+
+
+  EOS
+end
+
+def model_usage
+  puts <<-EOS
+  
+  
+    stone-gen model ModelName field:type field:type ...
+
+    e.g. stone-gen model Author name:string street_number:fixnum
+
+    Works just like all the other model generators out there, 
+    just remember that Stone only accepts Ruby primitives for 
+    field types (String, Fixnum, etc).
+
+
+  EOS
+end
+
+def gen_model(args)
+  model_name = args.first.camelcase
+  file_name = model_name.snakecase
+  args.shift
+  fields = Hash[*(args.map{|a| a.split(":") }.flatten)]
+  model_str = "class #{model_name}\n  include Stone::Resource\n\n"
+  for field in fields
+    unless field.last == "datetime"
+      model_str << "  field :#{field.first}, #{field.last.capitalize}\n"
+    else
+      model_str << "  field :#{field.first}, DateTime\n"
+    end
+  end
+  model_str << "end"
+  FileUtils.mkdir(File.join(Dir.pwd, "app/models")) \
+    unless File.exists?(File.join(Dir.pwd, "app/models"))
+  File.open(File.join(Dir.pwd, "app/models/#{file_name}.rb"), "w") do |file|
+    file << model_str
+  end
+  puts "Model: #{model_name} created."
+end
+
+if ARGV.empty?
+  usage
+else
+  args = ARGV
+  case args.first
+  when "model"
+    args.shift
+    if args.empty?
+      model_usage
+    else  
+      gen_model(args)
+    end
+  else
+    usage
+  end
+end

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'stone/version'
+
+AUTHOR = 'Nick DeMonner'  # can also be an array of Authors
+EMAIL = "nick@cladby.com"
+DESCRIPTION = "Super-simple data persistence layer created for small applications."
+GEM_NAME = 'stone' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'stone' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Stone::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'stone documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe # :nodoc:[all]
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [['english', '>= 0.2.0'], ['validatable', '>= 1.6.7'], ['facets', '>= 2.4.1'], ['fastercsv', '>= 1.2.3']]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/stone/callbacks.rb

@@ -0,0 +1,50 @@
+module Stone
+  class Callbacks < Hash
+    
+    CALLBACKS = [
+      :before_save,
+      :after_save,
+      :before_create,
+      :after_create,
+      :before_destroy,
+      :after_destroy
+      ]
+    
+    class << self
+      
+    end # self
+    
+    # Registers the +klass+ with the current instance of Callbacks in Resource
+    # === Parameters
+    # +klass+:: The class to be registered
+    def register_klass(klass)
+      self[klass.to_s.make_key] = {}
+      CALLBACKS.each do |cb_sym|
+        self[klass.to_s.make_key][cb_sym] = []
+      end
+    end
+    
+    # Adds a given +meth+ to the +cb_sym+ array in the current Callbacks 
+    # hash based on +klass+
+    # === Parameters
+    # +cb_sym+:: where +meth+ will be added
+    # +meth+:: method to be added
+    # +klass+:: determines which +cb_sym+ array will be used
+    def register(cb_sym, meth, klass)
+      self[klass.to_s.make_key][cb_sym] << meth
+    end
+    
+    # Sends any methods registered under +cb_sym+ to +obj+
+    # === Parameters
+    # +cb_sym+:: Used to retrieve the methods to send
+    # +obj+:: The object to which the retrieved methods are sent
+    def fire(cb_sym, obj)
+      unless obj.class.to_s.make_key == :class
+        self[obj.class.to_s.make_key][cb_sym].each do |meth|
+          obj.send(meth) unless meth.blank?
+        end
+      end
+      true
+    end
+  end # Callbacks
+end # Stone

data/lib/stone/core_ext/string.rb

@@ -0,0 +1,9 @@
+class String #:nodoc:
+  def /(o)
+    File.join(self, o.to_s)
+  end
+  
+  def make_key
+    self.downcase.to_sym
+  end
+end

data/lib/stone/core_ext/symbol.rb

@@ -0,0 +1,22 @@
+class Symbol
+  def gt;   Stone::Query.new(self.to_s, :gt);   end
+  def gte;  Stone::Query.new(self.to_s, :gte);  end
+  def lt;   Stone::Query.new(self.to_s, :lt);   end
+  def lte;  Stone::Query.new(self.to_s, :lte);  end
+  
+  def includes
+    Stone::Query.new(self.to_s, :includes)
+  end
+  
+  def matches
+    Stone::Query.new(self.to_s, :matches)
+  end
+  
+  def equals
+    Stone::Query.new(self.to_s, :equals)
+  end
+  
+  def not
+    Stone::Query.new(self.to_s, :not)
+  end
+end

data/lib/stone/data_store.rb

@@ -0,0 +1,80 @@
+module Stone
+  # An in-memory representation of the file-based datastore
+  class DataStore
+    
+    class << self
+      @dir ||= ""
+      
+      def local_dir=(value) #:nodoc:
+        @dir = value
+      end
+
+      # Provides the directory path to the local (app-specific) datastore
+      def local_dir
+        @dir || Dir.pwd/"datastore"
+      end
+      
+      # Loads yaml files specific to the resource represented by +sym+
+      # === Parameters
+      # +sym+::
+      #   Symbol representing resource data to load
+      def load_data(sym)
+        dir = self.local_dir
+        ymls = Dir.glob(dir/sym.to_s.pluralize/"*.yml")
+        objs = []
+        unless ymls.empty?
+          ymls.each do |yml|
+            obj = YAML.load_file yml
+            objs << [obj.id, obj]
+          end
+        end
+        return objs
+      end
+      
+      # If the object already exists (id was found),
+      # this returns +put+(update), else +post+(create)
+      # === Parameters
+      # +obj+::
+      #   The instantiated resource to be saved
+      # +store+:: 
+      #   DataStore object
+      def determine_save_method(obj, store)
+        store.resources[obj.class.to_s.make_key].each do |o|
+          return :put if o[0] == obj.id
+        end
+        :post
+      end
+      
+      # Persist the object via YAML
+      # === Parameters
+      # +obj+:: The object to be persisted
+      def write_yaml(obj)
+        path = self.local_dir/obj.class.to_s.downcase.pluralize/"#{obj.id}.yml"
+        File.open(path, 'w') do |out|
+          YAML.dump(obj, out)
+        end
+      end
+      
+      # Removes object's yaml file
+      # === Parameters
+      # +id+:: id of the object to be removed
+      # +klass_dir+:: directory in which object resides
+      def delete(id, klass_dir)
+        raise "Object could not be found" \
+          unless File.exists?(self.local_dir/klass_dir/"#{id}.yml")
+            
+        FileUtils.remove_file(self.local_dir/klass_dir/"#{id}.yml")
+        true
+      end
+    end # self
+    
+    def initialize
+      @resources = {}
+    end
+    
+    def resources
+      @resources
+    end
+    
+  end # DataStore
+end # Stone

data/lib/stone/query.rb

@@ -0,0 +1,44 @@
+module Stone
+  # Represents a single query condition
+  class Query
+    
+    attr_accessor :field, :op
+    
+    def initialize(field,op)
+      self.field = field
+      self.op = case op
+                  when :gt
+                    ".>"
+                  when :lt
+                    ".<"
+                  when :gte
+                    ".>="
+                  when :lte
+                    ".<="
+                  when :includes
+                    ".include?"
+                  when :matches
+                    ".=~"
+                  when :equals
+                    ".=="
+                  when :not
+                    ".!="
+                  end
+    end
+    
+    # Builds an expression from the conditions given during first or all
+    # === Parameters
+    # +arg+:: Some conditional argument
+    def expression_for(arg)
+      if arg.is_a? String
+        "#{self.field}#{self.op}('#{arg}')"
+      elsif arg.is_a? Regexp
+        "#{self.field}#{self.op}(#{arg.inspect})"
+      elsif arg.is_a? Date
+        "#{self.field}#{self.op}(DateTime.parse(\"#{arg}\"))"
+      else
+        "#{self.field}#{self.op}(#{arg})"        
+      end
+    end
+  end 
+end