manhattan 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,143 @@
+# Manhattan
+
+Manhattan is a gem extracted from the practices we used at [Xenda](http://xenda.pe "Xenda") in the development of our projects.
+
+It strives to be a simple status manager for models with minimal overhead and allowing the creation of a simple state machine. Most projects in our experience need for a model to hold a status at once and to perform some actions before or after obtaining that state. This gem simplifies that work without adding much overhead.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'manhattan'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install manhattan
+
+## Usage
+
+Models that want to be handled by Manhattan should include the gem on their definition:
+
+```ruby
+class ComicBook < ActiveRecord::Base
+  include Manhattan
+end
+```
+
+Manhattan will then wait for your to describe the list of states your class can hold:
+
+```ruby
+class ComicBook < ActiveRecord::Base
+  include Manhattan
+
+  has_statuses :opened, :sold
+
+end
+```
+
+For it to do its work, it'll assume the model has a "status" column of type string on your database. This can be customized by appending the "column_name" key at the end of your states list: 
+
+```ruby
+class ComicBook < ActiveRecord::Base
+  include Manhattan
+
+  has_statuses :opened, :sold, column_name: :state
+
+end
+```
+
+Manhattan will even allow you to setup a default state for initialized records. Take notice that this shouldn't be used instead of setting a default value on a migration or directly on your column.
+
+After this setup, Manhattan will give you some love in the form of code
+
+#### Getting a list of status
+
+```ruby
+ComicBook.statuses        #=>  ["opened", "sold"]
+ComicBook.new.statuses    #=>  ["opened", "sold"]
+```
+
+#### Setting a new status
+
+```ruby
+comic_book = ComicBook.new
+comic_book.mark_as_opened
+comic_book.status          #=>  "opened"
+```
+
+#### Querying about its status
+
+```ruby
+# directly asking for status
+comic_book.opened?         #=> "true"
+comic_book.sold?           #=> "false"
+
+# or even asking about its negative
+comic_book.unopened?       #=> "false"
+comic_book.not_sold?       #=> "true"
+```
+
+Manhattan will create alias like "invalid" "unsold" and "not_valid" for each state. Use whichever feels natural for your code.
+
+#### Performing actions before and after code changes
+
+Manhattan will look for before_* and after_* methods for each state. If they exist, it will run them accordingly: 
+
+```ruby
+class ComicBook < ActiveRecord::Base
+  # .... all the above code
+
+  def before_opened
+    puts "This is a sad day... when this comic loses its value"
+  end
+
+  def after_opened
+    puts "WE CRY NOW AND SHIVER FOR IT'S NO LONGER COLLECTABLE"
+  end
+```
+
+```ruby
+comic_book.mark_as_opened  #=>
+#"This is a sad day... when this comic loses its value"
+#"WE CRY NOW AND SHIVER FOR IT'S NO LONGER COLLECTABLE"
+````
+
+#### Model scopes
+
+Each model class has associated scopes created for easy returning records from the DB for each state:
+
+```ruby
+ComicBook.opened  #=>  select * from comic_books where status = 'opened'
+```
+
+#### Adding a default state
+
+If wanted, you can setup a default state for your model
+
+```ruby
+class ComicBook < ActiveRecord::Base
+  include Manhattan
+
+  has_statuses :opened, :sold, default_value: :opened
+end
+```
+
+```ruby
+ComicBook.new.status #=>  "opened"
+```
+
+## TODO
+
+Fairly simple, but I18N is pending.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/manhattan.rb

@@ -3,6 +3,7 @@ require "manhattan/version"
 module Manhattan
 
   extend ActiveSupport::Concern
+  class AlreadyDefinedMethod < StandardError; end
 
   def status_column_value
     self.send(self.class.status_column_name)
@@ -39,6 +40,10 @@ module Manhattan
     def has_statuses(*statuses)
       options = statuses.pop if statuses.last.is_a? Hash
       options ||= {}
+
+      common_methods = statuses & self.methods
+      raise Manhattan::AlreadyDefinedMethod, "Already defined method #{common_methods}" unless common_methods.empty?
+
       @status_column_name = options[:column_name]
       @status_column_name ||= :status
 
@@ -81,9 +86,9 @@ module Manhattan
     def define_query_methods(status)
 
       status_sym                 = status.to_sym
-      query                      = "#{status}?".to_sym
-      negative_query             = "not_#{query}".to_sym
-      alternative_negatives      = ["un#{query}".to_sym, "in#{query}".to_sym]
+      query                      = "is_#{status}?".to_sym
+      negative_query             = "is_not_#{status}?".to_sym
+      alternative_negatives      = ["is_un#{status}?".to_sym, "is_in#{status}?".to_sym]
 
       define_method query do
         status_column_value == status_value(status_sym)

data/lib/manhattan/version.rb

@@ -1,3 +1,3 @@
 module Manhattan
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -2,7 +2,7 @@
 name: manhattan
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alvaro Pereyra
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.10
+        version: '3.2'
     none: false
   name: rails
   type: :runtime
@@ -25,23 +25,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.10
-    none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-    none: false
-  name: sqlite3
-  type: :development
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
     none: false
 description: Easy way to define states on your classes
 email:
@@ -55,7 +39,7 @@ files:
 - lib/tasks/manhattan_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 homepage: ''
 licenses: []
 post_install_message: 

data/README.rdoc

@@ -1,29 +0,0 @@
-# Manhattan
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'manhattan'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install manhattan
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request