super_serialize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49276a8cd980eecd175a71086a6b864818148eb2
+  data.tar.gz: cac85ec1846157b96b1821e4dbf8bb9015b00f7a
+SHA512:
+  metadata.gz: ff53b0e707c04c0e894ca9021644603237341d7cde910879b9fcd45fa0a9646e6a836efd2b38e929b5ddc03f98fcb15691b21fa7762acc1a673d8ba09a4e8904
+  data.tar.gz: 37f8c8ebdee0a8a1c1a4d9915b2501ce61914aa4e5329b7e1c42e089f091f4f2391c330dbdf649450b38d9f89144002c4cb0fe9b1ee6bf61cfd6d68facc75e74

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.md

@@ -0,0 +1,97 @@
+# SuperSerialize
+
+A super, simple way to serialize anything from fixnums and floats to arrays and hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'super_serialize'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install super_serialize
+
+## Usage
+
+**In your model**
+
+    class SomeModel < ActiveRecord::Base
+      super_serialize :varied_attr_type, :other_varied_attr_type
+
+      ...
+    end
+
+**Examples**:
+
+    >  sm = SomeModel.new
+    >  sm.varied_attr_type = 3
+    >  sm.varied_attr_type
+    => 3
+
+    >  sm.varied_attr_type.class
+    => Fixnum
+
+    >  sm.varied_attr_type = "3"
+    >  sm.varied_attr_type
+    => 3
+
+    >  sm.varied_attr_type.class
+    => Fixnum
+
+    >  sm.varied_attr_type = "3.0"
+    >  sm.varied_attr_type
+    => 3.0
+
+    >  sm.varied_attr_type.class
+    => Float
+
+    >  sm.varied_attr_type = "some string"
+    >  sm.varied_attr_type
+    => "some string"
+
+    >  sm.varied_attr_type.class
+    => String
+
+    >  sm.varied_attr_type = [1,2]
+    >  sm.varied_attr_type
+    => [1,2]
+
+    >  sm.varied_attr_type.class
+    => Array
+
+    >  sm.varied_attr_type = "[1,2,3]"
+    >  sm.varied_attr_type
+    => [1,2]
+
+    >  sm.varied_attr_type.class
+    => Array
+
+    >  sm.varied_attr_type = "{key: 'some value'}"
+    >  sm.varied_attr_type
+    => {"key" => 'some value'}
+
+    >  sm.varied_attr_type.class
+    => ActiveSupport::HashWithIndifferentAccess
+
+    >  sm.varied_attr_type = {key: 'some value'}
+    >  sm.varied_attr_type
+    => {"key" => 'some value'}
+
+    >  sm.varied_attr_type.class
+    => ActiveSupport::HashWithIndifferentAccess
+
+
+## Contributing
+
+1. Fork it ( http://github.com/ricardo-quinones/super_serialize/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SuperSerialize'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/super_serialize/version.rb

@@ -0,0 +1,3 @@
+module SuperSerialize
+  VERSION = "0.0.1"
+end

data/lib/super_serialize.rb

@@ -0,0 +1,155 @@
+module SuperSerialize
+  extend ActiveSupport::Concern
+ 
+  included do
+    # Validations for super serialized columns
+    validate :check_if_super_serialized_attributes_are_valid_yaml
+
+    # Callback to yamlize super serialized columngs just prior to saving to the database
+    before_save :yamlize_super_serialized_attributes
+  end
+
+  module ClassMethods
+    def super_serialize(*attr_names)
+      # === Arguments
+      # +attr_names+:: the name of the of the attributes to be super_serialized
+      # === Example
+      #   class SomeModel < ActiveRecord::Base
+      #     super_serialize :varied_attr_type, :other_varied_attr_type
+      #   end
+      #
+      #   Attr type and class dynamically set based on the detected class type.
+      #   Value can be set with objects or with strings that gets serialized to
+      #   appropriate object via the YAML library
+      #
+      # === Example usage
+      #   >  sm = SomeModel.new
+      #   >  sm.varied_attr_type = 3
+      #   >  sm.varied_attr_type
+      #   => 3
+      #   >  sm.varied_attr_type.class
+      #   => Fixnum
+      #   >  sm.varied_attr_type = "3"
+      #   >  sm.varied_attr_type
+      #   => 3
+      #   >  sm.varied_attr_type.class
+      #   => Fixnum
+      #   >  sm.varied_attr_type = "3.0"
+      #   >  sm.varied_attr_type
+      #   => 3.0
+      #   >  sm.varied_attr_type.class
+      #   => Float
+      #   >  sm.varied_attr_type = "some string"
+      #   >  sm.varied_attr_type
+      #   => "some string"
+      #   >  sm.varied_attr_type.class
+      #   => String
+      #   >  sm.varied_attr_type = [1,2]
+      #   >  sm.varied_attr_type
+      #   => [1,2]
+      #   >  sm.varied_attr_type.class
+      #   => Array
+      #   >  sm.varied_attr_type = "[1,2,3]"
+      #   >  sm.varied_attr_type
+      #   => [1,2]
+      #   >  sm.varied_attr_type.class
+      #   => Array
+      #   >  sm.varied_attr_type = "{key: 'some value'}"
+      #   >  sm.varied_attr_type
+      #   => {"key" => 'some value'}
+      #   >  sm.varied_attr_type.class
+      #   => ActiveSupport::HashWithIndifferentAccess
+      #   >  sm.varied_attr_type = {key: 'some value'}
+      #   >  sm.varied_attr_type
+      #   => {"key" => 'some value'}
+      #   >  sm.varied_attr_type.class
+      #   => ActiveSupport::HashWithIndifferentAccess
+
+      attr_names.each do |attr_name|
+        unless column_names.include?(attr_name.to_s)
+          raise ArgumentError, ":#{attr_name} is not a valid column name for #{name}."
+        end
+
+        unless attr_name.is_a? Symbol
+          raise ArgumentError, "Please pass in symbols as arguments."
+        end
+      end
+
+      attr_names.each do |attr_name|
+        class_eval <<-RUBY, __FILE__, __LINE__+1
+          def #{attr_name}
+            value = super
+            return value.with_indifferent_access if value.is_a?(Hash)
+            return value unless is_valid_yaml?(value)
+
+            object = YAML::load(value)
+            object.is_a?(Hash) ? object.with_indifferent_access : object
+          end
+
+          def #{attr_name}=(value)
+            current_changed_attributes = changed_attributes.dup
+            return_value = super(value)
+
+            if #{attr_name} == #{attr_name}_was
+              @changed_attributes = current_changed_attributes
+            end
+
+            return_value
+          end
+
+          def #{attr_name}_was
+            value = super
+
+            if persisted? && is_valid_yaml?(value)
+              YAML::load(value)
+            else
+              value
+            end
+          end
+        RUBY
+      end
+
+      class_eval do
+        unless const_defined?('SUPER_SERIALIZED_ATTRIBUTES')
+          const_set('SUPER_SERIALIZED_ATTRIBUTES', attr_names)
+        end
+
+        private
+
+        def is_valid_yaml?(value)
+          begin
+            !!YAML.load(value)
+          rescue
+            false
+          end
+        end
+
+        def yamlize_super_serialized_attributes
+          self.class.const_get('SUPER_SERIALIZED_ATTRIBUTES').each do |attr_name|
+            next unless send(attr_name)
+            self.send("#{attr_name}=", send(attr_name).to_yaml)
+          end
+        end
+
+        def super_serialized_attr_as_string_or_yaml(attr_name)
+          if read_attribute(attr_name).is_a?(String)
+            read_attribute(attr_name)
+          else
+            send(attr_name).to_yaml
+          end
+        end
+
+        def check_if_super_serialized_attributes_are_valid_yaml
+          self.class.const_get('SUPER_SERIALIZED_ATTRIBUTES').each do |attr_name|
+            next unless send(attr_name)
+            unless is_valid_yaml?(super_serialized_attr_as_string_or_yaml(attr_name))
+              errors.add(attr_name, 'could not be properly serialized. Typical serializations are numbers, strings, arrays, or hashes.')
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, SuperSerialize

data/lib/tasks/super_serialize_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :super_serialize do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: super_serialize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricardo Quiñones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A super, simple way to serialize anything from fixnums and floats to
+  arrays and hashes.
+email:
+- r.a.quinones@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/super_serialize.rb
+- lib/super_serialize/version.rb
+- lib/tasks/super_serialize_tasks.rake
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Allows for dynamically serializing fixnums, floats, arrays, hashes, and,
+  of course, strings.
+test_files: []