kematzy-dm-is-published 0.0.2 → 0.0.3

data/.gitignore

@@ -10,6 +10,7 @@ tmtags
 coverage
 rdoc
 pkg
+doc
 
 ## PROJECT::SPECIFIC
 

data/README.rdoc

@@ -100,9 +100,9 @@ As I said above, for a better understanding of this gem/plugin, make sure you st
 == Errors / Bugs
 
 If something is not behaving intuitively, it is a bug, and should be reported.
-Report it here: http://datamapper.lighthouseapp.com/
+Report it here: http://github.com/kematzy/dm-is-published/issues
 
-=== Credits
+== Credits
 
 Copyright (c) 2009-07-11 [kematzy gmail com]
 

data/Rakefile

@@ -12,7 +12,7 @@ begin
     gem.email = "kematzy@gmail.com"
     gem.homepage = "http://github.com/kematzy/dm-is-published"
     gem.authors = ["kematzy"]
-    gem.extra_rdoc_files = %w[ README.rdoc LICENSE TODO History.txt ]
+    gem.extra_rdoc_files = %w[ README.rdoc LICENSE TODO History.rdoc ]
     gem.add_dependency('dm-core', '>= 0.10.0')
     gem.add_dependency('dm-validations', '>= 0.10.0')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -39,16 +39,37 @@ task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
+  version = File.exist?('VERSION') ? IO.read('VERSION').chomp : "[Unknown]"
+  
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "dm-is-published #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+
+desc 'Build the rdoc HTML Files'
+task :docs do
+  version = File.exist?('VERSION') ? IO.read('VERSION').chomp : "[Unknown]" 
+  
+  sh "sdoc -N --title 'DM::Is::Published v#{version}' lib/dm-is-published README.rdoc"
+end
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_rdoc] do 
+    sh "rm -rf doc"
+  end
+  
+  desc 'Force a rebuild of the RDOC files'
+  task :rebuild => [:docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end
+

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/dm-is-published.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-is-published}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kematzy"]
-  s.date = %q{2009-07-12}
+  s.date = %q{2009-08-20}
   s.description = %q{= dm-is-published
 
 This plugin makes it very easy to add different states to your models, like 'draft' vs 'live'. 
@@ -109,9 +109,9 @@ As I said above, for a better understanding of this gem/plugin, make sure you st
 == Errors / Bugs
 
 If something is not behaving intuitively, it is a bug, and should be reported.
-Report it here: http://datamapper.lighthouseapp.com/
+Report it here: http://github.com/kematzy/dm-is-published/issues
 
-=== Credits
+== Credits
 
 Copyright (c) 2009-07-11 [kematzy gmail com]
 
@@ -123,14 +123,14 @@ Released under the MIT license.
 }
   s.email = %q{kematzy@gmail.com}
   s.extra_rdoc_files = [
-    "History.txt",
+    "History.rdoc",
      "LICENSE",
      "README.rdoc",
      "TODO"
   ]
   s.files = [
     ".gitignore",
-     "History.txt",
+     "History.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",

data/lib/dm-is-published/is/published.rb

@@ -99,9 +99,9 @@ module DataMapper
     # == Errors / Bugs
     # 
     # If something is not behaving intuitively, it is a bug, and should be reported.
-    # Report it here: http://datamapper.lighthouseapp.com/
+    # Report it here: http://github.com/kematzy/dm-is-published/issues
     # 
-    # === Credits
+    # == Credits
     # 
     # Copyright (c) 2008-05-07 [Kematzy at gmail]
     # 
@@ -203,18 +203,21 @@ module DataMapper
           # -- (Hash)  => all(:key => "value") ( normal operations, so just pass on the Hash ) 
           # -- (Symbol)  => all(:draft) ( just get the symbol, )
           # -- (Symbol, Hash )  => :draft, { extra options }
+          # -- (DataMapper somethings) => leave it alone
           if args.empty?
             return super 
-          elsif args.first.is_a?(Hash)
-            return super(args.first)
-          else
+          elsif args.first.is_a?(Symbol)
             # set the from args Array, remove first item if Symbol, and then check for 2nd item's presence
-            state, options = args.shift.to_s, (args.blank? ? {} : args.first) if args.first.is_a?(Symbol)
+            state, options = args.shift.to_s, (args.blank? ? {} : args.first) 
             # puts " and state=[#{state}] and options=[#{options.class}] options.inspect=[#{options.inspect}] [#{__FILE__}:#{__LINE__}]"
-            
             return super({ :publish_status => state }.merge(options) )
+          elsif args.first.is_a?(Hash)
+            # puts "dm-is-published args.first was a HASH ] [#{__FILE__}:#{__LINE__}]"
+            return super(args.first)
+          else
+            # puts "dm-is-published (ELSE) [#{__FILE__}:#{__LINE__}]"
+            return super
           end
-          
         end
         
       end # ClassMethods

data/lib/dm-is-published/is/version.rb

@@ -1,7 +1,7 @@
 module DataMapper
   module Is
     module Published
-      VERSION = '0.0.2'
+      VERSION = '0.0.3'
     end
   end
 end

data/spec/integration/published_spec.rb

@@ -161,6 +161,15 @@ if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
         
       end #/ #self.all
       
+      describe "#first" do 
+        
+        it "should description" do 
+          # Article.first.should == ''
+          # Article.first(:title => "Live Article").should == ''
+        end
+        
+      end #/ #first
+      
     end #/ Class Methods
     
     describe "Instance Methods" do 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: kematzy-dm-is-published
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - kematzy
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 -07:00
+date: 2009-08-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,20 +32,20 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.10.0
     version: 
-description: "= dm-is-published  This plugin makes it very easy to add different states to your models, like 'draft' vs 'live'.  By default it also adds validations of the field value.  Originally inspired by the Rails plugin +acts_as_publishable+ by <b>fr.ivolo.us</b>.    == Installation  #  Add GitHub to your RubyGems sources  $  gem sources -a http://gems.github.com  $  (sudo)? gem install kematzy-dm-is-published  <b>NB! Depends upon the whole DataMapper suite being installed, and has ONLY been tested with DM 0.10.0 (next branch).</b>   == Getting Started  First of all, for a better understanding of this gem, make sure you study  the '<tt>dm-is-published/spec/integration/published_spec.rb</tt>' file.  ----  Require +dm-is-published+ in your app.  require 'dm-core'         # must be required first require 'dm-is-published'  Lets say we have an Article class, and each Article can have a current state,  ie: whether it's Live, Draft or an Obituary awaiting the death of someone famous (real or rumored)   class Article include DataMapper::Resource property :id,     Serial property :title,   String ...<snip>  is :published  end  Once you have your Article model we can create our Articles just as normal  Article.create(:title => 'Example 1')   The instance of <tt>Article.get(1)</tt> now has the following things for free:  * a <tt>:publish_status</tt> attribute with the value <tt>'live'</tt>. Default choices are <tt>[ :live, :draft, :hidden ]</tt>.  * <tt>:is_live?, :is_draft? or :is_hidden?</tt> methods that returns true/false based upon the state.  * <tt>:save_as_live</tt>, <tt>:save_as_draft</tt> or <tt>:save_as_hidden</tt> converts the instance to the state and saves it.  * <tt>:publishable?</tt> method that returns true for models where <tt>is :published </tt> has been declared, but <b>false</b> for those where it has not been declared.   The Article class also gets a bit of new functionality:  Article.all(:draft)  =>  finds all Articles with :publish_status = :draft   Article.all(:draft, :author => @author_joe )  =>  finds all Articles with :publish_status = :draft and author == Joe    Todo Need to write more documentation here..   == Usage Scenarios  In a Blog/Publishing scenario you could use it like this:  class Article  ...<snip>...  is :published :live, :draft, :hidden  end  Whereas in another scenario - like in a MenuItem model for a Restaurant - you could use it like this:  class MenuItem ...<snip>...  is :published  :on, :off  # the item is either on the menu or not  end   == RTFM   As I said above, for a better understanding of this gem/plugin, make sure you study the '<tt>dm-is-published/spec/integration/published_spec.rb</tt>' file.   == Errors / Bugs  If something is not behaving intuitively, it is a bug, and should be reported. Report it here: http://datamapper.lighthouseapp.com/  === Credits  Copyright (c) 2009-07-11 [kematzy gmail com]  Loosely based on the ActsAsPublishable plugin by [http://fr.ivolo.us/posts/acts-as-publishable]  == Licence  Released under the MIT license."
+description: "= dm-is-published  This plugin makes it very easy to add different states to your models, like 'draft' vs 'live'.  By default it also adds validations of the field value.  Originally inspired by the Rails plugin +acts_as_publishable+ by <b>fr.ivolo.us</b>.    == Installation  #  Add GitHub to your RubyGems sources  $  gem sources -a http://gems.github.com  $  (sudo)? gem install kematzy-dm-is-published  <b>NB! Depends upon the whole DataMapper suite being installed, and has ONLY been tested with DM 0.10.0 (next branch).</b>   == Getting Started  First of all, for a better understanding of this gem, make sure you study  the '<tt>dm-is-published/spec/integration/published_spec.rb</tt>' file.  ----  Require +dm-is-published+ in your app.  require 'dm-core'         # must be required first require 'dm-is-published'  Lets say we have an Article class, and each Article can have a current state,  ie: whether it's Live, Draft or an Obituary awaiting the death of someone famous (real or rumored)   class Article include DataMapper::Resource property :id,     Serial property :title,   String ...<snip>  is :published  end  Once you have your Article model we can create our Articles just as normal  Article.create(:title => 'Example 1')   The instance of <tt>Article.get(1)</tt> now has the following things for free:  * a <tt>:publish_status</tt> attribute with the value <tt>'live'</tt>. Default choices are <tt>[ :live, :draft, :hidden ]</tt>.  * <tt>:is_live?, :is_draft? or :is_hidden?</tt> methods that returns true/false based upon the state.  * <tt>:save_as_live</tt>, <tt>:save_as_draft</tt> or <tt>:save_as_hidden</tt> converts the instance to the state and saves it.  * <tt>:publishable?</tt> method that returns true for models where <tt>is :published </tt> has been declared, but <b>false</b> for those where it has not been declared.   The Article class also gets a bit of new functionality:  Article.all(:draft)  =>  finds all Articles with :publish_status = :draft   Article.all(:draft, :author => @author_joe )  =>  finds all Articles with :publish_status = :draft and author == Joe    Todo Need to write more documentation here..   == Usage Scenarios  In a Blog/Publishing scenario you could use it like this:  class Article  ...<snip>...  is :published :live, :draft, :hidden  end  Whereas in another scenario - like in a MenuItem model for a Restaurant - you could use it like this:  class MenuItem ...<snip>...  is :published  :on, :off  # the item is either on the menu or not  end   == RTFM   As I said above, for a better understanding of this gem/plugin, make sure you study the '<tt>dm-is-published/spec/integration/published_spec.rb</tt>' file.   == Errors / Bugs  If something is not behaving intuitively, it is a bug, and should be reported. Report it here: http://github.com/kematzy/dm-is-published/issues  == Credits  Copyright (c) 2009-07-11 [kematzy gmail com]  Loosely based on the ActsAsPublishable plugin by [http://fr.ivolo.us/posts/acts-as-publishable]  == Licence  Released under the MIT license."
 email: kematzy@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
+- History.rdoc
 - LICENSE
 - README.rdoc
 - TODO
 files: 
 - .gitignore
-- History.txt
+- History.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -60,6 +60,7 @@ files:
 - spec/spec_helper.rb
 has_rdoc: false
 homepage: http://github.com/kematzy/dm-is-published
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -80,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A DataMapper plugin that provides an easy way to add different states to your models.