bb_tag_closer 1.0.0 → 1.0.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Chase
+Copyright (c) 2012 Chase Conklin
 
 MIT License
 

data/README.md

@@ -1,9 +1,13 @@
 # BBTagCloser
 
-TODO: Write a gem description
+Automatically detects and closes bb_tags (the ones in forums) in the opposite order that they were added.
+
+"[u]My Underlined Text" becomes "[u]My Underlined Text[/u]"
 
 ## Installation
 
+This gem requires Rails 3.2 or later, it was developed and tested on Rails 3.2.9
+
 Add this line to your application's Gemfile:
 
     gem 'bb_tag_closer'
@@ -18,8 +22,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
+  To use on a model, call close_tags. This will automatically close bb_tags on text (not string) attributes of the model. If you wish to manually specify which attributes to close bb_tags on, call close_tags_for like so:
+  
+  close_tags_for :attribute1, attribute2, :on => # callback you wish to close tags on, accepts validation, create, update, and save (is save by default)
+  
+  If the attributes are protected by mass_assignment using the :as option such as attr_accessible :my_attribute, :as => :my_permission; use close_tags or close_tags_for :attribute1, :mass_assignment_keys => :my_permission or close_tags_for :attribute1, :mass_assignment_keys => [:my_permission1, :my_permission2]
+  
+  BBTagCloser closes [b], [i], [u], [s], [quote], [url], [img], [email], [youtube], [size], and [color] tags by default, each is able to accept additional parameters such as [quote=foo]#...[/quote]
+  To manually set the tags, call the following in an initializer file:
+  
+  BBTagCloser.configure { |config| config.bb_tags = ["u", "b", "s", "i", "quote", "url", "img", "email", "youtube", "size", "color", # More tags here] }
+
+  
 ## Contributing
 
 1. Fork it

data/changelog.md

@@ -1,3 +1,7 @@
 ## Version 1.0.0 ##
 
-Initial Release
+Initial Release
+
+## Version 1.0.1 ##
+
+Added ability to disable tag closing callback by specifying :no_callback => true

data/lib/bb_tag_closer/version.rb

@@ -1,3 +1,3 @@
 module BBTagCloser
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/bb_tag_closer.rb

@@ -14,34 +14,40 @@ module BBTagCloser
 
   module ClassMethods
 
-    # Text attributes are considered taggable by default
-    # Using close_tags_for overrides default with custom attributes
+    # ActiveRecord text attributes are considered taggable by default.
+    # Using close_tags_for overrides default attributes with custom attributes.
 
     def taggable_fields
       columns.map {|c| {c.name.to_sym => c.type}}.delete_if {|i| not i.value? :text}.map(&:keys).flatten
     end
 
     # Closes tags on text attributes.
-    # Closes tags before save by default, but can be overridden by passing :on
-    # the :on paramater accepts :save, :create, :update, :validation 
+    # Closes tags before save by default, but can be overridden by passing :on;
+    # the :on paramater accepts :save, :create, :update, :validation.
+    # Alternatively, pass :no_callback => true to prevent tags from being closed automatically
+    # (you will have to close them in the controller).
     # If custom mass_assignment is used such as attr_accessible :foo, :as => :bar
-    # pass :mass_assignment_keys => :bar or :mass_assignment_keys => [:bar, :baz]
-
+    # pass :mass_assignment_keys => :bar or :mass_assignment_keys => [:bar, :baz].
+    
     def close_tags(options = {})
-      target = options[:on] ? "before_#{options[:on]}" : "before_save"
-      send(target, :close_tags)
+      unless options[:no_callback]
+        target = options[:on] ? "before_#{options[:on]}" : "before_save"
+        send(target, :close_tags)
+      end
       mass_assignment_keys = Array options[:mass_assignment_keys]
       mass_assignment_keys.each do |key|
         attr_accessible :font_size, :font_color, :as => key
       end
     end
 
-    # Specify which attributes to close tags on. Accepts the same options as close_tags
+    # Specify which attributes to close tags on. Accepts the same options as close_tags.
 
     def close_tags_for(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
-      target = options[:on] ? "before_#{options[:on]}" : "before_save"
-      send(target, :close_tags)
+      unless options[:no_callback]
+        target = options[:on] ? "before_#{options[:on]}" : "before_save"
+        send(target, :close_tags)
+      end
       self.singleton_class.class_eval do
         define_method :taggable_fields do
           args.delete_if {|i| not i.is_a? Symbol}
@@ -51,10 +57,14 @@ module BBTagCloser
 
   end
 
+  # Sets configuration options. Currently supports setting of custom bb_tags through BBTagCloser.configure 
+  # {|config| config.bb_tags = ["u", "b", "s", "i", "quote", "url", "img", "email", "youtube", "size", "color", # additional tags ]}
+
   def self.configure(&block)
     yield BBTagCloser::Configuration
   end
 
+  # Called during a callback specified in the :on paramater in close_tags or close_tags_for. Closes forum tags in the opposite order they were added by the user.
 
   def close_tags
     text_attributes = self.class.taggable_fields

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bb_tag_closer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -90,3 +90,4 @@ summary: Allows the customization of tags in an initializer file, and can work w
 test_files:
 - spec/bb_tag_closer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: