act_as_releasable 0.0.4 → 0.0.5

data/README.md

@@ -1,6 +1,16 @@
 # ActAsReleasable
 
-TODO: Write a gem description
+A simple way to manage approval of ActiveRecord models.
+Using ActAsReleasable you can keep track of changed data by creating a candidate without modifying your current model.
+When you need, you can just approve the changes and all data will be updated to your model.
+
+## TL;DR
+
+```.act_as_releasable :collections => [:name_if_any]``` on your model.
+```#generate_new_candidate``` to apply changes to candidate(without saving).
+```#release_candidate``` to get candidate from model.
+```#release_version!``` to apply candidate changes to model.
+```#has_changes_to_be_approved?``` to check if there is any candidate.
 
 ## Installation
 
@@ -8,17 +18,51 @@ Add this line to your application's Gemfile:
 
     gem 'act_as_releasable'
 
-And then execute:
+And then execute (the second step is used to create the gem migrations):
 
     $ bundle
+	$ rails generate act_as_releasable:install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install act_as_releasable
+In order to make your model releasable, your must call the ```act_as_releasable``` method on your model, like this:
 
-## Usage
+	class Article
+	  act_as_releasable
+	end
+
+After created, any model who act as releasable is able to generate a candidate.
+
+	article = Article.find(5) # <Article id: 5, title: "Whoa! ActAsReleasable is live!", ...>
+	article.title = "ActAsRelesable just received some care :)"
+	article.generate_new_candidate
+
+Every ActiveRecord::Base model will work as usual, unless you specify it to behave like releasable(I mean, no AR method is overrided).
+
+After creating a new candidate, you can load it by doing the following.
+
+	article = Article.find(5) # <Article id: 5, title: "Whoa! ActAsReleasable is live!", ...>
+	# ...
+	article.release_candidate.title # "ActAsRelesable just received some care :)"
+
+To approve a candidate, you should use the ```release_version!``` method.
+
+	article = Article.find(5) # <Article id: 5, title: "Whoa! ActAsReleasable is live!", ...>
+	# ...
+	article.release_version!
+	article = Article.find(5) # <Article id: 5, title: "ActAsRelesable just received some care :)", ...>
+
+###The last but not the least:
+
+You can have candidates for collections, by specifying them like this:
+
+	class Article
+	  act_as_releasable :collections => [:comments]
+	end
+
+And check if the model has any change to be approved.
 
-TODO: Write usage instructions here
+	article.has_changes_to_be_approved?
 
 ## Contributing
 

data/act_as_releasable.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Gregório Kusowski"]
   gem.email         = ["gregorio.kusowski@gmail.com"]
   gem.description   = %q{Make your models work with a release candidate that must be approved}
-  gem.summary       = %q{wip}
-  gem.homepage      = ""
+  gem.summary       = "act_as_releasable-#{ActAsReleasable::VERSION}"
+  gem.homepage      = "https://github.com/gregoriokusowski/act_as_releasable"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/act_as_releasable/version.rb

@@ -1,3 +1,3 @@
 module ActAsReleasable
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: act_as_releasable
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -152,7 +152,7 @@ files:
 - spec/release_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-homepage: ''
+homepage: https://github.com/gregoriokusowski/act_as_releasable
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -175,7 +175,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: wip
+summary: act_as_releasable-0.0.5
 test_files:
 - spec/candidate_spec.rb
 - spec/db/database.yml