kematzy-dm-is-published 0.0.2

data/.gitignore

@@ -0,0 +1,15 @@
+## OS STUFF
+.DS_Store
+
+## TM SPECIFIC
+*.tmproj
+tmtags
+
+## PROJECT::GENERAL
+*.sw?
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / 2009-07-11
+
+* Release!
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kematzy [kematzy gmail com]
+
+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.rdoc

@@ -0,0 +1,113 @@
+= 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.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dm-is-published"
+    gem.version = IO.read('VERSION') || '0.0.0'
+    gem.summary = %Q{A DataMapper plugin that provides an easy way to add different states to your models.}
+    # gem.description = gem.summary
+    gem.description = IO.read('README.rdoc') || gem.summary
+    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.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
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+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
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dm-is-published #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/dm-is-published.gemspec

@@ -0,0 +1,172 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-is-published}
+  s.version = "0.0.2"
+
+  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.description = %q{= 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.
+}
+  s.email = %q{kematzy@gmail.com}
+  s.extra_rdoc_files = [
+    "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "dm-is-published.gemspec",
+     "lib/dm-is-published.rb",
+     "lib/dm-is-published/is/published.rb",
+     "lib/dm-is-published/is/version.rb",
+     "spec/integration/published_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kematzy/dm-is-published}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{A DataMapper plugin that provides an easy way to add different states to your models.}
+  s.test_files = [
+    "spec/integration/published_spec.rb",
+     "spec/spec_helper.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<dm-core>, [">= 0.10.0"])
+      s.add_runtime_dependency(%q<dm-validations>, [">= 0.10.0"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+      s.add_dependency(%q<dm-validations>, [">= 0.10.0"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0.10.0"])
+    s.add_dependency(%q<dm-validations>, [">= 0.10.0"])
+  end
+end

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

@@ -0,0 +1,259 @@
+module DataMapper
+  module Is
+    
+    # = 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:: add 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) 2008-05-07 [Kematzy at gmail]
+    # 
+    # Loosely based on the ActsAsPublishable plugin by [http://fr.ivolo.us/posts/acts-as-publishable]
+    # 
+    # == Licence
+    # 
+    # Released under the MIT license.
+    
+    module Published
+      
+      ##
+      # method that adds a basic published status attribute to your model
+      # 
+      # == params 
+      # 
+      # * +states+ - an array of 'states' as symbols or strings. ie: :live, :draft, :hidden
+      # 
+      # ==== Examples
+      # 
+      #   
+      #   is :published :on, :off
+      #   
+      #   is :published %w(a b c d)
+      #   
+      # 
+      # @api public
+      def is_published(*args)
+        # set default args if none passed in
+        args = [:live, :draft, :hidden] if args.blank?
+        args = args.first if args.first.is_a?(Array)
+        
+        # the various publish states accepted.
+        @publish_states = args.collect{ |state| state.to_s.downcase.to_sym }
+        @publish_states_for_validation = args.collect{ |state| state.to_s.downcase }
+        
+        extend  DataMapper::Is::Published::ClassMethods
+        include DataMapper::Is::Published::InstanceMethods
+        
+        # do we have a :publish_status declared
+        if properties.any?{ |p| p.name == :publish_status }
+          
+          # set default value to first value in declaration or the given value
+          d = properties[:publish_status].default.blank? ? @publish_states.first.to_s : properties[:publish_status].default
+          
+          # set the length to 10 if missing or if shorter than 5, otherwise use the given value
+          l = 5  if properties[:publish_status].length.blank?
+          l = (properties[:publish_status].length <= 10 ? 10 : properties[:publish_status].length)
+          
+          property :publish_status, String, :length => l, :default => d.to_s
+        else
+          # no such property, so adding it with default values
+          property :publish_status, String, :length => 10, :default => @publish_states.first.to_s 
+        end
+        
+        # create the state specific instance methods
+        self.publish_states.each do |state|
+          define_method("is_#{state}?") do 
+            self.publish_status == state.to_s
+          end
+          define_method("save_as_#{state}") do 
+            self.publish_status = state.to_s
+            save
+          end
+        end
+        
+        # ensure we are always saving publish_status values as strings
+        before :valid? do
+          self.publish_status = self.publish_status.to_s if self.respond_to?(:publish_status)
+        end
+        
+        validates_within    :publish_status, 
+                            :set => @publish_states_for_validation,
+                            :message => "The publish_status value can only be one of these values: [ #{@publish_states_for_validation.join(', ')} ]"
+        
+      end
+      
+      module ClassMethods
+        attr_reader :publish_states, :publish_states_for_validation
+        
+        ##
+        # Overriding the normal #all method to add some extra sugar.
+        #  
+        # ==== Examples
+        # 
+        #   Article.all  => returns all Articles as usual
+        # 
+        #   Article.all( :publish_status => :live )  => returns all Articles with :publish_status == :lve
+        # 
+        #   Article.all(:draft)  => returns all Articles with :publish_status == :draft
+        # 
+        #   Article.all(:draft, :author => @author_joe )  => finds all Articles with :publish_status = :draft and author == Joe
+        # 
+        # 
+        # @api public/private
+        def all(*args)
+          # incoming can either be:  
+          # -- nil (nothing passed in, so just use super )
+          # -- (Hash)  => all(:key => "value") ( normal operations, so just pass on the Hash ) 
+          # -- (Symbol)  => all(:draft) ( just get the symbol, )
+          # -- (Symbol, Hash )  => :draft, { extra options }
+          if args.empty?
+            return super 
+          elsif args.first.is_a?(Hash)
+            return super(args.first)
+          else
+            # 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)
+            # puts " and state=[#{state}] and options=[#{options.class}] options.inspect=[#{options.inspect}] [#{__FILE__}:#{__LINE__}]"
+            
+            return super({ :publish_status => state }.merge(options) )
+          end
+          
+        end
+        
+      end # ClassMethods
+      
+      module InstanceMethods 
+        
+        ##
+        # Ensuring all models using this plugin responds to publishable? with true.
+        #  
+        # ==== Examples
+        # 
+        #   @published_model.publishable?  =>  true
+        # 
+        # @api public
+        def publishable?
+          true
+        end
+        
+      end # InstanceMethods
+      
+      module ResourceInstanceMethods 
+        
+        ##
+        # Ensuring all models NOT using this plugin responds to publishable? with false.
+        #  
+        # ==== Examples
+        # 
+        #   @unpublished_model.publishable?  =>  false
+        # 
+        # @api public
+        def publishable?
+          false
+        end
+        
+      end #/module ResourceInstanceMethods
+      
+    end # Published
+  end # Is
+  
+  Model.append_extensions(Is::Published)
+  
+end # DataMapper

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

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

data/lib/dm-is-published.rb

@@ -0,0 +1,15 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~> 0.10.0'
+require 'dm-core'
+gem 'dm-validations', '~> 0.10.0'
+require 'dm-validations'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-published' / 'is' / 'published.rb'
+
+DataMapper::Model.append_extensions(DataMapper::Is::Published)
+DataMapper::Model.append_inclusions(DataMapper::Is::Published::ResourceInstanceMethods)

data/spec/integration/published_spec.rb

@@ -0,0 +1,303 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::Is::Published' do
+    
+    class DefaultsArticle
+      include DataMapper::Resource
+      property :id,     Serial
+      property :title,   String
+      
+      is :published
+    end 
+    
+    class Article
+      include DataMapper::Resource
+      property :id,     Serial
+      property :title,   String
+      
+      is :published, :live, :draft, :prepared
+    end 
+    
+    class Image
+      include DataMapper::Resource
+      property :id,     Serial
+      property :title,   String
+      
+      is :published, :yes, :no
+    end 
+    
+    
+    before(:each) do 
+      DefaultsArticle.auto_migrate!
+      Article.auto_migrate!
+      Image.auto_migrate!
+      
+      %w(live draft hidden).each do |state|
+        DefaultsArticle.create(:title => "#{state.capitalize} DefaultsArticle", :publish_status => state )
+      end
+      %w(live draft prepared).each do |state|
+        Article.create(:title => "#{state.capitalize} Article", :publish_status => state )
+      end
+      %w(yes no).each do |state|
+        Image.create(:title => "#{state.capitalize} Image", :publish_status => state )
+      end
+      
+    end
+    
+    
+    describe "Property :publish_status" do 
+      
+      class ArticleWithoutDefaultAndTooShortLength
+        include DataMapper::Resource
+        property :id,     Serial
+        property :publish_status, String, :length => 2
+        
+        is :published
+      end 
+      
+      class ArticleWithDefaultAndLongerLength
+        include DataMapper::Resource
+        property :id,     Serial
+        property :publish_status, String, :length => 100, :default => 'hidden' 
+        
+        is :published
+      end 
+      
+      describe ":length => X" do 
+        
+        it "should set the :publish_status length to the default value of 5 if declared shorter" do 
+          ArticleWithoutDefaultAndTooShortLength.properties[:publish_status].length.should == 10
+        end
+        
+        it "should NOT set the :publish_status length to the default value of 5 if declared is longer" do 
+          ArticleWithDefaultAndLongerLength.properties[:publish_status].length.should == 100
+        end
+        
+      end #/ length
+      
+      describe ":default => X" do 
+        
+        it "should set the :publish_status default value to the first item in the method declaration" do 
+          ArticleWithoutDefaultAndTooShortLength.properties[:publish_status].default.should == 'live'
+          Article.properties[:publish_status].default.should == 'live'
+          Image.properties[:publish_status].default.should == 'yes'
+        end
+        
+        it "should set the default value to the declared value" do 
+          ArticleWithDefaultAndLongerLength.properties[:publish_status].default.should == 'hidden'
+        end
+        
+      end #/ default
+      
+    end #/ Property :publish_status
+    
+    describe "Class Methods" do 
+      
+      describe "#publish_states" do 
+        
+        it "should return the states as an array of Symbols" do 
+          DefaultsArticle.publish_states.should == [:live, :draft, :hidden]
+          Article.publish_states.should == [:live, :draft, :prepared]
+          Image.publish_states.should == [:yes, :no]
+        end
+        
+        class ArticleWithDeclarationAsArray
+          include DataMapper::Resource
+          property :id,     Serial
+          is :published, [:a, :b, :c]
+        end 
+        
+        it "should handle the states declared within [ Array ] brackets" do
+          ArticleWithDeclarationAsArray.publish_states.should == [:a, :b, :c]
+        end
+        
+        class ArticleWithDeclarationAsArrayOfStrings
+          include DataMapper::Resource
+          property :id,     Serial
+          is :published, %w(a b c)
+        end 
+        
+        it "should handle the states declared as %w(a b c) " do
+          ArticleWithDeclarationAsArrayOfStrings.publish_states.should == [:a, :b, :c]
+        end
+        
+      end #/ #publish_states
+      
+      describe "#publish_states_for_validation" do 
+        
+        it "should return the states as an array of Strings" do 
+          DefaultsArticle.publish_states_for_validation.should == ["live", "draft", "hidden"]
+          Article.publish_states_for_validation.should == ["live", "draft", "prepared"]
+          Image.publish_states_for_validation.should == ["yes", "no"]
+        end
+        
+      end #/ #publish_states
+      
+      describe "#all" do 
+        
+        before(:each) do 
+          5.times do |n|
+            Article.create(:title => "Dummy Article #{n +1}")
+          end
+        end
+        
+        it "should work as expected with Model.all" do
+          Article.all.size.should == 8
+        end
+        
+        it "should work as expected with Model.all(:publish_status => state) (finding only those records with the state) " do 
+          Article.all( :publish_status => :live ).size.should == 6
+        end
+        
+        it "should work as expected with Model.all(:state) (finding only those records with the given state) " do 
+          Article.all(:live).size.should == 6
+        end
+        
+        it "should work as expected with Model.all(:state,{ conditions } ) (finding only the items with the given state and conditions) " do 
+          Article.all(:live, :title => "Dummy Article 1" ).size.should == 1
+        end
+        
+      end #/ #self.all
+      
+    end #/ Class Methods
+    
+    describe "Instance Methods" do 
+      
+      describe "#publish_status" do 
+        
+        it "should return the state as a String" do 
+          Article.get(1).publish_status.should be_a_kind_of(String)
+        end
+        
+        it "should set the default status as the first item in the list when is :published is defined " do
+          a = Article.create(:title => "Article with default publish_status" )
+          a.publish_status.should == 'live'
+        end
+        
+      end #/ #publish_status
+      
+      describe "#publishable?" do 
+        
+        it "should return true for a Model with is :published declared" do 
+          Article.get(1).publishable?.should == true
+        end
+        
+        it "should return false when Model does NOT have is :published declared" do 
+          class UnPublishedModel
+            include DataMapper::Resource
+            property :id, Serial
+          end
+          
+          UnPublishedModel.new.should respond_to(:publishable?)
+          UnPublishedModel.new.publishable?.should == false
+        end
+        
+      end #/ #publishable?
+      
+      describe "defined :is_STATE? methods" do 
+        
+        describe "#is_live?" do 
+          
+          it "should return true on live articles" do 
+            Article.get(1).is_live?.should == true
+          end
+          
+          it "should return false on all others" do 
+            Article.get(2).is_live?.should == false
+            Article.get(3).is_live?.should == false
+          end
+          
+        end #/ #is_live?
+        
+        describe "#is_draft?" do 
+          
+          it "should return true on draft articles" do 
+            Article.get(2).is_draft?.should == true
+          end
+          
+          it "should return false on all others" do 
+            Article.get(1).is_draft?.should == false
+            Article.get(3).is_draft?.should == false
+          end
+          
+        end #/ #is_draft?
+        
+        describe "#is_prepared?" do 
+          
+          it "should return true on prepared articles" do 
+            Article.get(3).is_prepared?.should == true
+          end
+          
+          it "should return false on all others" do 
+            Article.get(1).is_prepared?.should == false
+            Article.get(2).is_prepared?.should == false
+          end
+          
+        end #/ #is_prepared?
+        
+      end #/ defined :is_STATE? methods
+      
+      describe "defined :save_as_STATE? methods" do 
+        
+        Article.publish_states.each do |state| 
+          
+          describe "#save_as_#{state}" do 
+            
+            it "should save item as :#{state}" do 
+              a = Article.new(:title => "Saved As #{state.to_s.capitalize} article" )
+              a.send("save_as_#{state}").should == true
+              a.publish_status.should == state.to_s
+            end
+            
+          end #/ #save_as_
+          
+        end
+        
+        Image.publish_states.each do |state| 
+          
+          describe "#save_as_#{state}" do 
+            
+            it "should save item as :#{state}" do 
+              a = Image.new(:title => "Saved As #{state.to_s.capitalize}" )
+              a.send("save_as_#{state}").should == true
+              a.publish_status.should == state.to_s
+            end
+            
+          end #/ #save_as_
+          
+        end
+        
+        it "should enable changing the publish status" do 
+          a = Article.get(1)
+          a.publish_status.should == 'live'
+          a.save_as_draft
+          a.reload
+          a.publish_status.should == 'draft'
+        end
+        
+      end #/ defined :is_STATE? methods
+      
+    end #/ Instance Methods
+    
+    describe "Validations" do 
+      
+      it "should accept the defined states" do 
+        %w(live draft prepared).each do |state|
+          a = Article.new(:title => "Accepted Validated Article", :publish_status => state )
+          a.save.should == true
+          a.errors.on(:publish_status).should == nil
+        end
+      end
+      
+      it "should reject all other states and return a Validation error with the possible states in the message text" do 
+        a = Article.new(:title => "Rejected Article", :publish_status => :invalid )
+        a.save.should == false
+        a.errors.on(:publish_status).should == ["The publish_status value can only be one of these values: [ live, draft, prepared ]"]
+      end
+      
+    end #/ Validations
+    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'rspec', '~>1.2.6'
+require 'spec'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-published'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: kematzy-dm-is-published
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- kematzy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: dm-validations
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !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."
+email: kematzy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .gitignore
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- dm-is-published.gemspec
+- lib/dm-is-published.rb
+- lib/dm-is-published/is/published.rb
+- lib/dm-is-published/is/version.rb
+- spec/integration/published_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/kematzy/dm-is-published
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A DataMapper plugin that provides an easy way to add different states to your models.
+test_files: 
+- spec/integration/published_spec.rb
+- spec/spec_helper.rb