flag_shih_tzu 0.3.12 → 0.3.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90b55064f920798177d3ca8c7eaf24141d275266
-  data.tar.gz: 4c56f730ebcd6de7721312f81809ecede06cbcd7
+  metadata.gz: a2714d0ae0f43d03bd6e24a3ac96ec0a5a2126ec
+  data.tar.gz: 5f31617f4cb4c1ef1e3ad3ccc3db9a813004bfa7
 SHA512:
-  metadata.gz: 3b9a1d00be762409224b7cafd6244a93cf062ff721d218ea5c9b167ee6963cfa1a1a1ba8ce3b24ae71146df74e674771d58e9139b139eb4c822c7af0546f108b
-  data.tar.gz: e5438b3889ca9d3caf04d18b54ecc26587190368978fa8cc51626b41c30596fa051a08c02a43a98aa3ce36d4a8938845d1e01a4dc87e3d651f5ecc5ad64fd2a6
+  metadata.gz: 4494baacf8d5733f126459e7880e5cb33e8465a59de8d709262da9734c447c49085d5b165c7bbfc468ec7479f9965371384b6a55d0f43ef9edb227783c1cafe1
+  data.tar.gz: bd3ef847e260134e8ed842fe6c176473f56538e677ec3396285babfba7d4c5213acf920a141667620c7351de8696316b84500503d29def67ec4c854475627ed2

data/.travis.yml

@@ -1,8 +1,8 @@
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.2
+  - 2.2.1
 gemfile:
   - gemfiles/Gemfile.activerecord-2.3.x
   - gemfiles/Gemfile.activerecord-3.0.x
@@ -12,6 +12,22 @@ gemfile:
   - gemfiles/Gemfile.activerecord-4.1.x
 matrix:
   exclude:
+    - rvm: 2.2.1
+      gemfile: gemfiles/Gemfile.activerecord-2.3.x
+    - rvm: 2.2.1
+      gemfile: gemfiles/Gemfile.activerecord-3.0.x
+    - rvm: 2.2.1
+      gemfile: gemfiles/Gemfile.activerecord-3.1.x
+    - rvm: 2.2.1
+      gemfile: gemfiles/Gemfile.activerecord-3.2.x
+    - rvm: 2.2.1
+      gemfile: gemfiles/Gemfile.activerecord-4.0.x
+    - rvm: 2.1.2
+      gemfile: gemfiles/Gemfile.activerecord-2.3.x
+    - rvm: 2.1.2
+      gemfile: gemfiles/Gemfile.activerecord-3.0.x
+    - rvm: 2.1.2
+      gemfile: gemfiles/Gemfile.activerecord-3.1.x
     - rvm: 2.1.2
       gemfile: gemfiles/Gemfile.activerecord-2.3.x
     - rvm: 2.1.2

data/{CHANGELOG → CHANGELOG.md}

@@ -1,4 +1,18 @@
+Version 0.3.13 - MAR.13.2015
+
+* methods for use with form builders like simple_form by Peter Boling
+
+    - chained_flags_with_signature
+    - chained_#{colmn}_with_signature
+    - as_flag_collection
+    - as_#{colmn.singularize}_collection
+    - selected_flags=
+    - selected_#{colmn}= (already existed)
+* Testing on Travis: added Ruby 2.2.1
+* Testing on Travis: removed Ruby 1.9.2
+
 Version 0.3.12 - OCT.01.2014
+
 * Improve testing instructions in readme by Peter Boling
 * fix check_flag_column to return false after warn by Peter Boling
 * bash script for running complete test suite on Ruby 1.9.3 and Ruby 2.1.2 by Peter Boling
@@ -9,34 +23,41 @@ Version 0.3.12 - OCT.01.2014
 * Use Kernel#warn instead of puts by Peter Boling
 
 Version 0.3.11 - JUL.09.2014
+
 * Rename some ambigously-named methods mixed into AR::Base by jdelStrother
 * Add dynamic ".*_values_for" helpers by atipugin
 
 Version 0.3.10 - NOV.26.2013
+
 * Can run tests without coverage by specifying NOCOVER=true by Peter Boling
 * Improved test coverage by Peter Boling
 * Improved documentation by Peter Boling
 * Readme converted to Markdown by Peter Boling
 
 Version 0.3.9 - NOV.25.2013
+
 * Removed runtime dependency on active record and active support by Peter Boling
 * Fixed Coveralls Configuration by Peter Boling
 * Improved Readme by Peter Boling
 
 Version 0.3.8 - NOV.24.2013
+
 * Improved Readme / Documentation by Peter Boling
 * Added Badges by Peter Boling
 * Configured Coveralls by Peter Boling
 * Added Code Climate, Coveralls, Gemnasium, and Version Badges by Peter Boling
 
 Version 0.3.7 - OCT.25.2013
+
 * Change `sql_in_for_flag` to consider values from the range [0, 2 * max - 1] by Blake Thomson
 
 Version 0.3.6 - AUG.29.2013
+
 * Allow use with any gem manager by Peter Boling
 * No need to alter Ruby's load path by Peter Boling
 
 Version 0.3.5 - AUG.06.2013
+
 * Fix Travis Build & Add Rails 4 by Peter M. Goldstein
 * Implemented update_flag! by Peter Boling (see https://github.com/pboling/flag_shih_tzu/issues/27)
   - sets a flag on a record without triggering callbacks or validations
@@ -60,6 +81,7 @@ Version 0.3.4 - JUN.20.2013
 * Many more tests, including arity tests by Peter Boling
 
 Version 0.3.3 - JUN.20.2013
+
 - Does not exist.
 
 Version 0.3.2 - NOV.06.2012

data/README.md

@@ -48,9 +48,9 @@ What is a ["Shih Tzu"](http://en.wikipedia.org/wiki/Shih_Tzu)?
 The gem is actively being tested with:
 
 * MySQL, PostgreSQL and SQLite3 databases
-* ActiveRecord versions 2.3.x, 3.0.x, 3.1.x, 3.2.x
-* Ruby 1.8.7, 1.9.2, 1.9.3, and 2.0.0 (see .travis.yml for the matrix)
-
+* ActiveRecord versions 2.3.x, 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x ;)
+* Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.2 (see .travis.yml for the matrix)
+* Legacy Ruby 1.8.7 compatibility is in the [0.2.X branch](https://github.com/pboling/flag_shih_tzu/tree/0.2.X)
 
 ## Installation
 

data/lib/flag_shih_tzu.rb

@@ -29,7 +29,6 @@ module FlagShihTzu
         :strict => false,
         :check_for_column => true
       }.update(opts)
-      colmn = opts[:column].to_s
       if !is_valid_flag_column_name(opts[:column])
         warn "FlagShihTzu says: Please use a String to designate column names! I see you here: #{caller.first}"
         opts[:column] = opts[:column].to_s
@@ -61,7 +60,6 @@ module FlagShihTzu
         raise ArgumentError, "has_flags: flag name #{flag_name} already defined, please choose different name" if method_defined?(flag_name)
 
         flag_mapping[colmn][flag_name] = 1 << (flag_key - 1)
-        #puts "Defined: #{flag_key} as #{flag_mapping[colmn][flag_name]}"
 
         class_eval <<-EVAL, __FILE__, __LINE__ + 1
           def #{flag_name}
@@ -144,9 +142,9 @@ module FlagShihTzu
             end
 
             # useful for a form builder
-            def selected_#{colmn}=(selected_flags)
+            def selected_#{colmn}=(chosen_flags)
               unselect_all_flags('#{colmn}')
-              selected_flags.each do |selected_flag|
+              chosen_flags.each do |selected_flag|
                 enable_flag(selected_flag.to_sym, '#{colmn}') if selected_flag.present?
               end
             end
@@ -155,6 +153,14 @@ module FlagShihTzu
               not selected_#{colmn}.empty?
             end
 
+            def chained_#{colmn}_with_signature(*args)
+              chained_flags_with_signature('#{colmn}', *args)
+            end
+
+            def as_#{colmn.singularize}_collection(*args)
+              as_flag_collection('#{colmn}', *args)
+            end
+
           EVAL
         end
 
@@ -211,15 +217,15 @@ module FlagShihTzu
       raise NoSuchFlagException.new("determine_flag_colmn_for: Couldn't determine column for your flags!")
     end
 
-    def chained_flags_with(*args)
+    def chained_flags_with(column = DEFAULT_COLUMN_NAME, *args)
       if (ActiveRecord::VERSION::MAJOR >= 3)
-        where(chained_flags_condition(*args))
+        where(chained_flags_condition(column, *args))
       else
-        all(:conditions => chained_flags_condition(*args))
+        all(:conditions => chained_flags_condition(column, *args))
       end
     end
 
-    def chained_flags_condition(colmn, *args)
+    def chained_flags_condition(colmn = DEFAULT_COLUMN_NAME, *args)
       "(#{self.table_name}.#{colmn} in (#{chained_flags_values(colmn, *args).join(',')}))"
     end
 
@@ -385,6 +391,15 @@ module FlagShihTzu
     all_flags(colmn).map { |flag_name| self.send(flag_name) ? flag_name : nil }.compact
   end
 
+  # Useful for a form builder
+  # use selected_#{column}= for custom column names.
+  def selected_flags=(chosen_flags)
+    unselect_all_flags
+    chosen_flags.each do |selected_flag|
+      enable_flag(selected_flag.to_sym, DEFAULT_COLUMN_NAME) if selected_flag.present?
+    end
+  end
+
   def select_all_flags(colmn = DEFAULT_COLUMN_NAME)
     all_flags(colmn).each do |flag|
       enable_flag(flag, colmn)
@@ -420,8 +435,43 @@ module FlagShihTzu
     end
   end
 
+  # Use with chained_flags_with to find records with specific flags set to the same values as on this record.
+  # For a record that has sent_warm_up_email = true and the other flags false:
+  # user.chained_flags_with_signature
+  #   => [:sent_warm_up_email, :not_follow_up_called, :not_sent_final_email, :not_scheduled_appointment]
+  # User.chained_flags_with('flags', *user.chained_flags_with_signature)
+  # => the set of Users that have the same flags set as user.
+  def chained_flags_with_signature(colmn = DEFAULT_COLUMN_NAME, *args)
+    flags_to_collect = args.empty? ? all_flags(colmn) : args
+    truthy_and_chosen = selected_flags(colmn).select {|x| flags_to_collect.include?(x) }
+    truthy_and_chosen.concat(
+      collect_flags(*flags_to_collect) do |memo, flag|
+        memo << "not_#{flag}".to_sym unless truthy_and_chosen.include?(flag)
+      end
+    )
+  end
+
+  # Use with a checkbox form builder, like simple_form's
+  #   # selected_flags, used in the example below, is a method defined by flag_shih_tzu for bulk setting flags
+  #   form_for @user do |f|
+  #     f.collection_check_boxes :selected_flags, f.object.as_flag_collection('flags', :sent_warm_up_email, :not_follow_up_called), :first, :last
+  #   end
+  def as_flag_collection(colmn = DEFAULT_COLUMN_NAME, *args)
+    flags_to_collect = args.empty? ? all_flags(colmn) : args
+    collect_flags(*flags_to_collect) do |memo, flag|
+      memo << [flag, self.flag_enabled?(flag, colmn)]
+    end
+  end
+
   private
 
+    def collect_flags(*args)
+      args.inject([]) do |memo, flag|
+        yield memo, flag
+        memo
+      end
+    end
+
     def get_bit_for(flag, colmn)
       self.flags(colmn) & self.class.flag_mapping[colmn][flag]
     end

data/lib/flag_shih_tzu/version.rb

@@ -1,3 +1,3 @@
 module FlagShihTzu
-  VERSION = "0.3.12"
+  VERSION = "0.3.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flag_shih_tzu
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
 platform: ruby
 authors:
 - Peter Boling
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -142,7 +142,7 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Bit fields for ActiveRecord
@@ -192,3 +192,4 @@ test_files:
 - test/flag_shih_tzu_test.rb
 - test/schema.rb
 - test/test_helper.rb
+has_rdoc: