stone 0.1.0

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/stone/version.rb'
+
+version  = Stone::VERSION::STRING
+download = 'http://rubyforge.org/projects/stone'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/spec/callbacks_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Stone::Callbacks do
+  before(:all) do
+    get_resources
+    Stone.start(STONE_ROOT/"sandbox_for_specs", @resources)
+    
+    class Dude
+      include Stone::Resource
+      
+      def raise_hell
+        raise "Zomgz!"
+      end
+    end
+  end
+  
+  before(:each) do
+    @c = Stone::Callbacks.new
+  end
+  
+  it "should register a class for callbacks" do
+    @c.register_klass(Dude)
+    @c.include?(:dude).should be_true
+    @c[:dude].include?(:before_save).should be_true
+  end
+  
+  it "should register a method to execute for a given callback" do
+    @c.register_klass(Dude)
+    @c.register(:before_save, :raise_hell, Dude)
+    @c[:dude][:before_save].include?(:raise_hell).should be_true
+  end
+  
+  it "should fire the correct method when a callback is executed" do
+    # had to define say_hello to raise an error because fire() always
+    # returns true
+    
+    @c.register_klass(Dude)
+    @c.register(:before_save, :raise_hell, Dude)
+    
+    # raises "Zomgz!"
+    Dude.class_eval {fire(:before_save)}.should raise_error
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Stone::Query do
+  before(:all) do
+    get_resources
+    Stone.start(STONE_ROOT/"sandbox_for_specs", @resources)
+  end
+  
+  it "should craft a correct Query when initialized" do
+    q = Stone::Query.new("email", :lt)
+    q.field.should == "email"
+    q.op.should == ".<"
+  end
+  
+  it "should craft a proper expression for a given argument" do
+    q = Stone::Query.new("email", :not)
+    q.expression_for("nick@cladby.com").should == "email.!=('nick@cladby.com')"
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,190 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Stone::Resource do
+  
+  before(:all) do
+    get_resources
+    Stone.start(STONE_ROOT/"sandbox_for_specs", @resources)
+  end
+  
+  before(:each) do
+    @author = Author.new
+  end
+  
+  it "should extend any class in which it is included" do
+    class Blah #:nodoc:
+      include Stone::Resource
+    end
+    Blah.new.respond_to?(:field).should be_true
+  end
+  
+  it "should be valid when validates_ methods are fulfilled" do
+    @author.name = "Nick DeMonner"
+    @author.email = "nick@cladby.com"
+    @author.should be_valid
+  end
+  
+  it "should be invalid when validates_ methods are not fulfilled" do
+    @author.name = "Nick DeMonner"
+    @author.should_not be_valid
+  end
+  
+  it "should be invalid when a field's class does not match its declaration" do
+    @author.name = 3
+    @author.email = "nick@cladby.com"
+    @author.save.should_not be_true
+  end
+  
+  it "should create a yaml file for each saved object" do
+    @author.name = "Nick DeMonner"
+    @author.email = "nick@cladby.com"
+    @author.save
+    File.exists?(Stone::DataStore.local_dir/"authors"/"1.yml").should be_true
+  end
+  
+  it "should create an object whose id is last object.id + 1" do
+    @author.id.should == 2
+  end
+  
+  it "should not save unless all validations pass" do
+    @author.name = "Heyo McGee"
+    @author.save.should_not be_true
+  end
+  
+  it "should find and return an object using get" do
+    @author.name = "Mike McMichaels"
+    @author.email = "heyo@something.com"
+    @author.save
+    person = Author.get(@author.id)
+    person.name.should == "Mike McMichaels"
+  end
+  
+  it "should find and return an object using []" do
+    @author.name = "Mary Poppins"
+    @author.email = "weyo@something.com"
+    @author.save
+    person = Author[@author.id]
+    person.name.should == "Mary Poppins"
+  end
+  
+  it "should accept Resource.find(hash) form" do
+    author = Author.first(:name => "Nick DeMonner")
+    author.should be_instance_of(Author)
+  end
+  
+  it "should accept be able to find an object using a regex" do
+    author = Author.first(:name.matches => /nick/i)
+    author.should be_instance_of(Author)
+  end
+  
+  it "should raise an exception anything other than a Hash is provided for find" do
+    lambda {Author.first("Nick")}.should raise_error
+  end
+  
+  it "should find and return all objects that match conditions provided" do
+    @author.name = "Nick Hicklesby"
+    @author.email = "nick@gmail.com"
+    @author.save
+    people = Author.all(:name.includes => "Nick")
+    people.size.should == 2
+  end
+  
+  it "should find and return the first object that matches conditions provided" do
+    person = Author.first(:name.equals => 'Nick DeMonner')
+    person.id.should == 1
+  end
+  
+  it "should let .first and .all work with fields that aren't Strings" do
+    @author.name = "Higglesby Wordsworth"
+    @author.email = "higglebear@higgly.com"
+    @author.favorite_number = 3
+    @author.save
+    Author.first(:favorite_number.equals => 3).should be_instance_of(Author)
+  end
+  
+  it "should perform a put if the object already exists on save" do
+    author = Author.first(:name.equals => 'Nick DeMonner')
+    author.email = "nick@bzzybee.com"
+    author.save
+    Author.get(author.id).email.should == "nick@bzzybee.com" 
+  end
+  
+  it "should delete an object and it's yaml file upon Resource.delete" do
+    author = Author.first(:favorite_number.equals => 3)
+    Author.delete(author.id).should be_true
+  end
+  
+  it "should execute Resource callbacks" do
+    @author.name = "ben hurr"
+    @author.email = "chariot_guy@hotmail.com"
+    @author.save
+    @author.name.should == "Ben Hurr"
+  end
+  
+  it "should not save if there is a duplicate and the field is unique" do
+    @author.name = "John Doe"
+    @author.email = "nick@bzzybee.com"
+    @author.save.should_not be_true
+  end
+  
+  it "should retrieve a parent object if belongs_to has been set" do
+    @post = Post.new
+    @post.title = "Stone is Cool"
+    @post.body = "Stone is cool because..."
+    author = Author.first(:name.equals => 'Nick DeMonner')
+    @post.author_id = author.id
+    @post.save
+    @post.author.should be_instance_of(Author)
+  end
+  
+  it "should retrieve children objects id has_many has been set" do
+    @post = Post.new
+    @post.title = "Stone is Awesome"
+    @post.body = "Stone is awesome because..."
+    author = Author.first(:name.equals => 'Nick DeMonner')
+    @post.author_id = author.id
+    @post.save
+    author.posts.size.should == 2
+  end
+  
+  it "should accept Resource.new(hash) form" do
+    @author = Author.new(:name => "Ron DeMonner", :email => "ron@cladby.com")
+    @author.should be_valid
+  end
+  
+  it "should accept Resource.new(params[:resource]) form" do
+    params = {}
+    params[:author] = {:name => "Ron DeMonner", :email => "ron@cladby.com"}
+    @author = Author.new(params[:author])
+    @author.should be_valid
+  end
+  
+  it "should accept Resource.update_attributes(hash)" do
+    params = {}
+    params[:author] = {:name => "Ron DeMonner", :email => "ron@cladby.com"}
+    
+    plain_hash = {:name => "Nick DeMonner", :email => "nick@cladby.com"}
+    
+    author = Author.first(:name => "Nick DeMonner")
+    author.update_attributes(params[:author]).should be_true
+    author.update_attributes(plain_hash).should be_true
+  end
+  
+  it "should allow an attribute to accessed via obj[attribute]" do
+    author = Author.first(:name => "Nick DeMonner")
+    author[:id].should == 1
+  end
+  
+  it "should allow for DateTime queries" do
+    # bring back all authors who were created before a month from now
+    # i.e., bring all of them back
+    authors = Author.all(:created_at.lt => DateTime.now>>1)
+    authors.size.should == 5
+  end
+  
+  it "should allow for complex queries" do
+    authors = Author.all(:name.matches => /o/, :created_at.lt => DateTime.now>>1)
+    authors.size.should == 2
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'spec'
+require 'lib/stone'
+
+def get_resources
+  @resources = Dir.glob(STONE_ROOT/"sandbox_for_specs"/"sample_resources/*")
+end

data/spec/stone_spec.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Stone do
+  before(:all) do
+    get_resources
+    Stone.start(STONE_ROOT/"sandbox_for_specs", @resources)
+  end
+  
+  it "should create a new, blank datastore at a given path" do
+    File.exists?(STONE_ROOT/"sandbox_for_specs"/"datastore").should be_true
+  end
+end

data/spec/string_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe String do
+  before(:all) do
+    get_resources
+    Stone.start(STONE_ROOT/"sandbox_for_specs", @resources)
+  end
+  
+  it "should correctly form paths using /" do
+    ("this"/"should"/"work").should == "this/should/work"
+  end
+  
+  it "should make a proper key given a stringified class" do
+    String.to_s.make_key.should == :string
+  end
+end

data/spec/symbol_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+describe Symbol do
+  before(:all) do
+    get_resources
+    Stone.start(STONE_ROOT/"sandbox_for_specs", @resources)
+  end
+  
+  it "should return a correct Query when a comparison method is used" do
+    :name.gt.should be_instance_of(Stone::Query)
+    :name.gt.op.should == ".>"
+    
+    :name.matches.should be_instance_of(Stone::Query)
+    :name.matches.op.should == ".=~"
+  end
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]