cosine-active_record_encoding 0.9.1

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009, Michael H. Buselli
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/active_record_encoding.rb

@@ -0,0 +1,150 @@
+#
+# Copyright (c) 2009, Michael H. Buselli
+# See LICENSE for details.  All other rights reserved.
+#
+#######
+
+#
+# ActiveRecordEncoding — Module to make ActiveRecord aware of Unicode
+# encoding issues.
+#
+# ActiveRecordEncoding keeps two variables on the default encoding to
+# use when accessing the database.
+#
+#   ActiveRecordEncoding.external_encoding = 'ISO-8859-1'
+#   ActiveRecordEncoding.internal_encoding = 'UTF-8'
+#
+# If the external_encoding is not explicitly set then no conversions
+# will be done.  The internal_encoding value defaults to
+# Encoding.default_internal if not explicitly set.
+#
+# The internal_encoding value is the encoding of the Strings that are
+# returned by ActiveRecord from String-based columns.  The
+# external_encoding value tells ActiveRecord how the database is
+# encoding the data.  A conversion is done if necessary.
+#
+# When data is being saved back to the database, the internal_encoding
+# value is ignored and the encoding of the input is used to determine
+# how to encode the data in the external_encoding.
+#
+# Encodings may also be defined on a table-by-table basis in the model
+# definition.  A future version of ActiveRecordEncoding may support
+# setting the encoding on a column-by-column basis, but that is not
+# currently possible.
+#
+module ActiveRecordEncoding
+
+  class << self
+    attr_accessor :external_encoding, :internal_encoding
+  end
+
+  #
+  # Set both ActiveRecordEncoding.external_encoding and
+  # ActiveRecordEncoding.internal_encoding in a single method.
+  #
+  #   ActiveRecordEncoding.encoding = 'UTF-8'
+  #
+  def encoding= (new_encoding)
+    @internal_encoding = @external_encoding = new_encoding
+  end
+  module_function :encoding=
+end
+
+
+
+module ActiveRecordEncoding::ActiveRecordExtensionClassMethods
+
+  #
+  # Set the external_encoding value for this model class.
+  #
+  #   class User < ActiveRecord::Base
+  #     external_encoding 'ISO-8859-1'
+  #   end
+  #
+  # When data is retrieved from the database, it will be assumed it is
+  # encoded in the given format.
+  #
+  def external_encoding (new_encoding)
+    @active_record_external_encoding = new_encoding
+  end
+
+  #
+  # Set the internal_encoding value for this model class.
+  #
+  #   class User < ActiveRecord::Base
+  #     internal_encoding 'UTF-8'
+  #   end
+  #
+  # When String objects are returned to the user as a result of an
+  # ActiveRecord database lookup, they will be in the given format.
+  #
+  def internal_encoding (new_encoding)
+    @active_record_internal_encoding = new_encoding
+  end
+
+  #
+  # Set both the external_encoding and the internal_encoding values for
+  # this model class.
+  #
+  #   class User < ActiveRecord::Base
+  #     encoding 'UTF-8'
+  #   end
+  #
+  # When data is retrived from the database, it will be assumed it is
+  # encoded in the given format and returned in the same format.
+  #
+  def encoding (new_encoding)
+    @active_record_external_encoding = new_encoding
+    @active_record_internal_encoding = new_encoding
+  end
+
+  def active_record_external_encoding #:nodoc:
+    @active_record_external_encoding ||
+        ActiveRecordEncoding.external_encoding
+  end
+
+  def active_record_internal_encoding #:nodoc:
+    @active_record_internal_encoding ||
+        ActiveRecordEncoding.internal_encoding ||
+        Encoding.default_internal ||
+        Encoding.default_external ||
+        'UTF-8'
+  end
+end
+
+
+class ActiveRecord::Base #:nodoc:
+  extend ActiveRecordEncoding::ActiveRecordExtensionClassMethods
+
+
+  def encoding_aware_read_attribute (attr_name)
+    value = pre_encoding_aware_read_attribute(attr_name)
+
+    if value.respond_to? :encoding and value.encoding.to_s.eql?('ASCII-8BIT')
+      external_encoding = self.class.active_record_external_encoding
+
+      if external_encoding = self.class.active_record_external_encoding
+        internal_encoding = self.class.active_record_internal_encoding
+        value.force_encoding(external_encoding).encode!(internal_encoding)
+      end
+    end
+
+    value
+  end
+
+  alias_method :pre_encoding_aware_read_attribute, :read_attribute
+  alias_method :read_attribute, :encoding_aware_read_attribute
+
+
+  def encoding_aware_write_attribute (attr_name, value)
+    if value.respond_to? :encoding and
+          external_encoding = self.class.active_record_external_encoding
+      value = value.encode(external_encoding)
+    end
+
+    pre_encoding_aware_write_attribute(attr_name, value)
+  end
+
+  alias_method :pre_encoding_aware_write_attribute, :write_attribute
+  alias_method :write_attribute, :encoding_aware_write_attribute
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: cosine-active_record_encoding
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+platform: ruby
+authors: 
+- Michael H. Buselli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Library to monkey-patch ActiveRecord and add some Unicode awareness
+email: cosine@cosine.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/active_record_encoding.rb
+has_rdoc: true
+homepage: http://cosine.org/
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: active_record_encoding
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Library to monkey-patch ActiveRecord and add some Unicode awareness
+test_files: []
+