awesome_flags 1.2.0 → 1.3.0

data/README.markdown

@@ -1,23 +1,39 @@
-= awesome_flags
+# awesome_flags
+
+You'll need the FlagShihTzu plugin installed.
+
+    plugin install git://github.com/xing/flag_shih_tzu.git
+    
+Then set that up how you like. [FlagShihTzu](http://github.com/xing/flag_shih_tzu.git "FlagShihTzu repo")
+
+Then get the awesome_flags gem.
   
-  $gem 'awesome_flags'
+    gem 'awesome_flags'
 
-AwesomeFlags returns the keys used in a FlagShihTzu column as symbols.
+## AwesomeFlags outputs the keys used in FlagShihTzu columns as an Array of :symbols.
 
 Just require AwesomeFlags in your model. Don't forget to install the FlagShihTzu plugin and add that as well.
 
-To call all flags for a model use the method
-  $my_flags
+    include FlagShihTzu
+    include AwesomeFlags
+
+Call all active flags for a variable, or add a column name to filter.
+    
+    my_flags    
+    my_flags("column_name")
+
+Using the all_flags method will return all flags (filtered by column or not).
 
-To call just the flags from a specific column use:
-  $my_flags("column_name")
+    all_flags
+    all_flags("column_name")
 
-Using the all_flags method will return all flags (filtered by column or not as above).
-These will test true/false for that object so can be used to generate checkboxes in a form.
+You can also send either method to a block to output formatted flags.   
+This can be handy to do things like generate check boxes dynamically. For example
 
-You can also send either method to a block to output formatted flags.
+    - @form.all_flags.each do |flag|
+      = check_box flag, :class => 'check_box'
+      = label :flags, "#{flag.to_s.titleize}"
 
-== Copyright
 
 Copyright (c) 2011 Gabe Kessler. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/awesome_flags.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "awesome_flags"
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gabe Kessler"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awesome_flags
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Gabe Kessler