army-negative 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+= 1.0.0, release 2011-03-11
+
+* Initial Release
+

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (C) 2011 by Kendall Gifford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,45 @@
+= army-negative: negative one's for true!
+
+This gem is a simple ActiveRecord MySQL (+ARMy+) connection adapter
+monkey-patch. Put it in your +Gemfile+ and all your +true+ are belong to us! Or,
+rather, they'll suddenly become very negative, negative one specifically.
+
+== What This Does
+
+This makes ActiveRecord store the value -1 into your +TINYINT+ +boolean+ columns
+whenever they're set to +true+. It also makes ActiveRecord recognize -1 as true
+when a +boolean+ field is queried.
+
+*NOTE:* positive one and all other values that were interpreted as +true+ by the
+MySQL connection adapter will still be recognized as +true+ too.
+
+== Why
+
+This was written for a rails application that needed to access a legacy MySQL
+database. The new application needed to work concurrently with the existing
+(old) application, following its conventions.
+
+The old application is a Microsoft Access 2003 _program_ that uses the "linked
+tables" feature to store the data in a MySQL database. Microsoft's Visual Basic
+for Applications (VBA) stores +true+ values in memory with all bits turned on.
+If interpreted as an integer using two's complement, this is negative one. So
+the old application stores all our +true+ values as negative one. Because of
+this, many of the hand-written legacy queries also write and expect to read true
+values as negative one.
+
+== The Name
+
+Though no one besides myself is likely to see or use this gem, I still wanted to
+push it out to the public for posterity. The +ar+ in ARmy is for ActiveRecord
+while the +my+ in arMy is for MySQL. I'm sure you can guess what _negative_ is
+supposed to reference.
+
+== Authors and Credits
+
+Authors:: Kendall Gifford
+
+== License
+
+Licensed using the standard {MIT License}[http://en.wikipedia.org/wiki/MIT_License].
+See the file {LICENSE}[http://github.com/zettabyte/army-negative/blob/master/LICENSE]
+in the root folder of the project.

data/lib/army-negative.rb

@@ -0,0 +1,23 @@
+require 'army-negative/railtie' if defined?(Rails)
+
+module Army
+  module Negative
+
+    autoload :Column,       'army-negative/column'
+    autoload :Quoting,      'army-negative/quoting'
+    autoload :MysqlAdapter, 'army-negative/mysql_adapter'
+
+    def patch_active_record!
+      ActiveRecord::ConnectionAdapters::Column.send  :include, Column
+      ActiveRecord::ConnectionAdapters::Quoting.send :include, Quoting
+    end
+    module_function :patch_active_record!
+
+    def patch_mysql_adapter!
+      require 'active_record/connection_adapters/mysql_adapter'
+      ActiveRecord::ConnectionAdapters::MysqlAdapter.send :include, MysqlAdapter
+    end
+    module_function :patch_mysql_adapter!
+
+  end
+end

data/lib/army-negative/column.rb

@@ -0,0 +1,32 @@
+require 'set'
+
+module Army
+  module Negative
+    module Column
+      TRUE_VALUES_WITH_NEGATIVE_ONES = [-1, '-1'].to_set
+
+      #
+      # Extend ActiveRecord::ConnectionAdapters::Column
+      #
+      def self.included(klass)
+        klass.send(:extend, ClassMethods)
+        klass.instance_eval do
+          class << self
+            alias_method_chain :value_to_boolean, :negative_ones
+          end
+        end
+      end
+
+      module ClassMethods
+        #
+        # Recognize integer -1 and string '-1' as "true" values.
+        #
+        def value_to_boolean_with_negative_ones(value)
+          return true if TRUE_VALUES_WITH_NEGATIVE_ONES.include?(value)
+          value_to_boolean_without_negative_ones(value)
+        end
+      end
+
+    end
+  end
+end

data/lib/army-negative/mysql_adapter.rb

@@ -0,0 +1,26 @@
+require 'set'
+
+module Army
+  module Negative
+    module MysqlAdapter
+
+      QUOTED_TRUE_AS_NEGATIVE_ONE = "-1".freeze
+
+      def self.included(klass)
+        klass.instance_eval do
+          alias_method :quoted_true, :quoted_true_as_negative_one
+        end
+      end
+
+      #
+      # This doesn't seem to actually be necessary in rails 3.0 (though it doesn't
+      # break anything either) but I'm doing this for completeness: make is so
+      # that MySQL adapter-specific calls to #quoted_true also get "-1".
+      #
+      def quoted_true_as_negative_one
+        QUOTED_TRUE_AS_NEGATIVE_ONE
+      end
+
+    end
+  end
+end

data/lib/army-negative/quoting.rb

@@ -0,0 +1,25 @@
+module Army
+  module Negative
+    module Quoting
+
+      #
+      # Extend ActiveRecord::ConnectionAdapters::Quoting
+      #
+      def self.included(klass)
+        klass.instance_eval do
+          alias_method_chain :quote, :negative_one
+        end
+      end
+
+      #
+      # Ensure "true" values get stored as -1 in the database where they'd
+      # normally have been stored as 1
+      #
+      def quote_with_negative_one(value, column = nil)
+        result = quote_without_negative_one(value, column)
+        (value.is_a?(TrueClass) and result == '1') ? '-1' : result
+      end
+
+    end
+  end
+end

data/lib/army-negative/railtie.rb

@@ -0,0 +1,13 @@
+require 'army-negative'
+require 'rails'
+
+module Army
+  module Negative
+    class Railtie < Rails::Railtie
+      initializer "army-negative.patch_active_record", :after => "active_record.initialize_database" do
+        Army::Negative.patch_active_record!
+        Army::Negative.patch_mysql_adapter!
+      end
+    end
+  end
+end

data/lib/army-negative/version.rb

@@ -0,0 +1,10 @@
+module Army
+  module Negative
+    module Version
+      MAJOR  = 1
+      MINOR  = 0
+      TINY   = 0
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: army-negative
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Kendall Gifford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: |-
+  When this gem is loaded in your rails app (Gemfile) your MySQL connection
+  adapter for ActiveRecord will be monkey-patched. The patch simply tweaks it
+  to store all boolean "true" values as negative one instead of positive one
+  inside your TINYINT columns. It also patches it to recognize and interpret
+  negative one as "true". Positive one will still be recognized as true as
+  well.
+  Used for special cases, such as developing rails apps that must, for
+  example, work with existing databases that use such a convention.
+email: 
+- zettabyte@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/army-negative/column.rb
+- lib/army-negative/railtie.rb
+- lib/army-negative/mysql_adapter.rb
+- lib/army-negative/quoting.rb
+- lib/army-negative/version.rb
+- lib/army-negative.rb
+- LICENSE
+- README.rdoc
+- CHANGELOG.rdoc
+has_rdoc: true
+homepage: http://github.com/zettabyte/army-negative/wiki
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: army-negative
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Monkey-patches ActiveRecord's MySQL (ARMy) connection adapter to store boolean trues as negative ones
+test_files: []
+