seria 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjU2OGRiY2JlMjQ2OTA3YTFkM2RlNDUxODUzZWUyNjQ5YmEyNjlmNg==
+  data.tar.gz: !binary |-
+    M2JkYmZhZjYxYmViNTRiNzA0ZWQ4YTc2ZGYyNzgwNTg5MTA5MDUwZQ==
+SHA512:
+  metadata.gz: !binary |-
+    OTVmODUyYTM0YTc3OWQzYjI4OTA2N2U5ZDUzODVhMjY4MTk2ZjE4OGExYTEx
+    OGNmOTY1NDNjNDVjZDcyYWY4NGYwY2VhNzEwZGJkNjQwN2E4MjY3MjM4NGE5
+    NTI2YWM1OTViZjVhMjNiMWZlOTMxZDdmZTE4MGFjNDBkZmJmNjM=
+  data.tar.gz: !binary |-
+    OGVjOGVmNTZkMDUyZDYyNDFmOTFiYTc2MDhhMzYwN2M4NjU5Mjc3MzdhNzUw
+    MDc5YjRjODVmMjMwZTYxNzU3ZWQwZDcyZjJmMDMzZGU0MTg4MjJiM2FkN2Qw
+    OWRjY2NjYzNmNmY3YmYxNmZkYmIyMDhiMWQxMjU5NzI3ZWI1MWE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sparky.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ronna
+
+MIT License
+
+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,95 @@
+# Seria
+
+I wrote this gem because I needed to be able to load my ARs with key-value attributes without running migrations,
+in a similar way to [dynamic_attributes](https://github.com/moiristo/dynamic_attributes) gem.
+But I also needed to be able to query the data, so storing it in a JSON wasn't a good enough solution.
+
+Seria lets you add completely dynamic data to your ARs.
+Seria doesn't store your hash data in a JSON, but in separate records making it queryable.
+Seria will automatically cast your attributes back to their original type when loaded from the database -
+no more messy string manipulations.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seria'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seria
+
+## Usage
+
+### Generate the info table
+
+    $ rails g info_table book
+    $ rake db:migrate
+
+### Register your info table owner and start loading attributes
+
+```ruby
+
+class Book
+  include Seria::InfoTableOwner
+end
+
+book = Book.new(title: "The portable")
+book.infos["price"]=100.0
+book.infos["author"] = 'Dorothy Paker'
+book.infos["recommended"] = true
+book.save
+
+book = Book.last
+book.infos["price"]
+=> 100.0
+book.infos["recommended"]
+=> true
+
+```
+
+### Querying
+
+Seria stores your data in separate table with the fields foreign_id, field_name, field_value and field_type
+
+```sql
+/* The values are saved as strings, so when querying the database you need to convert to your original type: */
+select CAST(field_value as decimal(10,2)) as price from book_infos where field_name = "price"
+```
+
+```ruby
+class BookInfo #yes, you can define yourself
+  scope :prices, proc{ where('field_name="price"') }
+end
+
+cheep_books = BookInfo.prices.where('CAST(field_value as decimal(10,2)) < 10') #database
+cheep_books = BookInfo.prices.select{|p| p.field_value < 10} #memory
+
+```
+
+### Configure your own table-names, fields and converters
+
+```ruby
+Seria.configure do |config|
+  config.fields.key = :fkey
+  config.fields.value = :fvalue
+  config.fields.type = :ftype
+  config.descriptor = :data
+  config.converters["price"] = Seria::BigDecimalConverter
+end
+```
+
+
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/generators/info_table_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/named_base'
+module Seria
+  module Generators
+    module Migration
+      class InfoTableGenerator < Rails::Generators::NamedBase
+        include Rails::Generators::Migration
+        namespace "info_table"
+        source_root File.expand_path('../templates', __FILE__)
+
+        def create_migration
+          migration_template(
+              "#{self.class.generator_name}.rb",
+              "db/migrate/create_#{file_name}_#{suffix}.rb"
+          )
+        end
+
+        def self.next_migration_number(dirname) #:nodoc:
+          next_migration_number = current_migration_number(dirname) + 1
+          if ActiveRecord::Base.timestamped_migrations
+            [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+          else
+            "%.3d" % next_migration_number
+          end
+        end
+
+        def suffix
+          Seria.table_suffix
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/info_table.rb

@@ -0,0 +1,10 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= migration_class_name.underscore.downcase.gsub(/^create_/,'')%> do |t|
+      t.string :<%= Seria.config.fields.key %>
+      t.string :<%= Seria.config.fields.value %>
+      t.string :<%= Seria.config.fields.type %>
+      t.integer :<%=migration_class_name.underscore.downcase.gsub(/^create_/,'').gsub(/_#{suffix}$/,'')%>_id
+    end
+  end
+end

data/lib/seria/converters.rb

@@ -0,0 +1,69 @@
+module Seria
+  class DefaultConverter
+    attr_reader :value, :type
+    def initialize(value, type)
+      @value, @type = value, type
+    end
+
+    def klass
+      if type.present?
+        type
+      else
+        value.class.to_s
+      end
+    end
+
+    def conversions
+      @conversions ||=
+          {
+              'Fixnum' => lambda { value.to_i },
+              'BigDecimal' => lambda { value.to_d },
+              'Float' => lambda { value.to_f },
+              'NilClass' => nil,
+              'FalseClass' => false,
+              'TrueClass' => true,
+              'String' => lambda { value.to_s },
+              'Time' => lambda { Time.parse(value) },
+              'DateTime' => lambda { DateTime.parse(value) },
+              'Date' => lambda { Date.parse(value) },
+              'ActiveSupport::TimeWithZone' => lambda { Time.zone.parse(value) }
+          }
+    end
+
+    def convert
+      if value.class.to_s != klass
+        conversion = conversions[klass]
+        if conversion.is_a?(Proc)
+          conversion.call
+        else
+          conversion
+        end
+      else
+        value
+      end
+    end
+
+    def to_db
+      value
+    end
+  end
+
+  class BigDecimalConverter
+    attr_reader :value, :type
+    def initialize(value, type)
+      @value, @type = value, type
+    end
+
+    def convert
+      if value && !value.is_a?(BigDecimal)
+        value.to_d
+      else
+        value
+      end
+    end
+
+    def to_db
+      value
+    end
+  end
+end

data/lib/seria/info_table.rb

@@ -0,0 +1,116 @@
+require "seria/version"
+require 'seria/converters'
+
+module Seria
+
+  module InfoTable
+
+    extend ActiveSupport::Concern
+
+    included do
+      klass_name = self.name.gsub(Seria.descriptor.camelize, '')
+      belongs_to klass_name.downcase.to_sym
+      alias_method :owner, klass_name.downcase.to_sym
+
+      before_save :to_db
+      attr_reader :in_memory
+    end
+
+    def convert
+      converter.convert
+    end
+
+    def converters
+      Seria.config.converters || {}
+    end
+
+    def converter
+      (converters[field_name] ||
+          converters[field_type] ||
+          DefaultConverter).new(
+          read_attribute(Seria.config.fields.value),
+          read_attribute(Seria.config.fields.type))
+    end
+
+    def field_name
+      read_attribute Seria.config.fields.key
+    end
+
+    def field_value
+      convert
+    end
+    def field_type
+      read_attribute(Seria.config.fields.type)
+    end
+    def field_type=(val)
+      write_attribute(Seria.config.fields.type, val)
+    end
+    def field_value=(val)
+      write_attribute(Seria.config.fields.value, val)
+    end
+
+    def to_db
+      self.field_value = convert #force cast back from varchar in case not a new entry
+      self.field_type = read_attribute(Seria.config.fields.value).class.to_s
+      self.field_value = converter.to_db
+      true
+    end
+
+    def self.define_info_table(class_name)
+      if !eval("defined?(#{class_name}) && #{class_name}.is_a?(Class)")
+        Object.const_set class_name, Class.new(ActiveRecord::Base)
+      end
+      klass = class_name.constantize
+      klass.send(:include, Seria::InfoTable) unless klass.include? Seria::InfoTable
+      if Rails.version =~ /^3/
+        klass.send(:attr_accessible, *(Seria.config.fields.marshal_dump.values))
+      end
+    end
+
+  end
+
+  module InfoTableOwner
+
+    extend ActiveSupport::Concern
+
+    included do
+      InfoTable::define_info_table class_name
+
+      has_many class_name.tableize.to_sym, class_name: class_name, :autosave => true do
+
+        def []= key, val
+          info = lookup(key)
+          if info
+            info.field_value = val
+            info.field_type = val.class.name
+          else
+            build(
+                Seria.config.fields.key => key,
+                Seria.config.fields.value => val,
+                Seria.config.fields.type => val.class.name
+            )
+          end
+          val
+        end
+        def [] key
+          info = lookup(key)
+          info.field_value if info
+        end
+        def lookup key
+          to_a.select{|i| i.field_name == key}.first
+        end
+      end
+      alias_method :my_infos, class_name.tableize.to_sym
+      alias_method Seria.table_suffix.to_sym, class_name.tableize.to_sym
+    end
+
+    module ClassMethods
+
+      def class_name
+        "#{self.to_s}#{Seria.descriptor.camelize}"
+      end
+
+    end
+
+  end
+end

data/lib/seria/version.rb

@@ -0,0 +1,3 @@
+module Seria
+  VERSION = "1.0.0"
+end

data/lib/seria.rb

@@ -0,0 +1,27 @@
+require "seria/version"
+require "seria/info_table"
+require 'ostruct'
+module Seria
+  @config = OpenStruct.new
+  @config.descriptor = :info
+  @config.converters = {}
+  @config.fields = OpenStruct.new(
+      {
+          key: :field_name,
+          value: :field_value,
+          type: :field_type
+      })
+  def self.configure
+    yield @config
+  end
+
+  def self.descriptor
+    config.descriptor.to_s
+  end
+  def self.table_suffix
+    descriptor.tableize
+  end
+  def self.config
+    @config
+  end
+end

data/seria.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seria/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seria"
+  spec.version       = Seria::VERSION
+  spec.authors       = ["Ronna"]
+  spec.email         = [""]
+  spec.description   = %q{}
+  spec.summary       = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/converters_spec.rb

@@ -0,0 +1,62 @@
+require 'rspec'
+require 'active_record'
+require 'active_support'
+
+require_relative '../lib/seria'
+
+ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    encoding: 'utf8',
+    database: ":memory:")
+
+class User < ActiveRecord::Base
+  include Seria::InfoTableOwner
+end
+Time.zone = "Berlin"
+describe Seria::DefaultConverter do
+
+  examples = {
+      1 => Fixnum,
+      true => TrueClass,
+      false => FalseClass,
+      1.0 => Float,
+      1.to_d => BigDecimal,
+      nil => NilClass,
+      "cool" => String,
+      Date.yesterday => Date,
+      Time.now => Time,
+      DateTime.now => DateTime,
+      Time.zone.now => ActiveSupport::TimeWithZone
+  }
+
+  examples.each do |value, klass|
+    describe :klass do
+      it "should return class #{klass} when no type given" do
+        Seria::DefaultConverter.new(value, nil).klass.should == klass.to_s
+      end
+    end
+
+    describe :convert do
+      it "should convert #{value} from String to #{klass}" do
+        Seria::DefaultConverter.new(value.to_s, klass.to_s).convert.class.should == klass
+      end
+      it "should return #{klass} to it's original value" do
+        val = Seria::DefaultConverter.new(value.to_s, klass.to_s).convert
+        val.class.should == klass
+        val.should == value
+      end
+      it "returns original #{klass} when already converted" do
+        val = Seria::DefaultConverter.new(value, klass.to_s).convert
+        val.class.should == klass
+        val.should == value
+      end
+      it "returns original #{klass} when no type given" do
+        val = Seria::DefaultConverter.new(value, nil).convert
+        val.class.should == klass
+        val.should == value
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: seria
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ronna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: 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'
+description: ''
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/info_table_generator.rb
+- lib/generators/templates/info_table.rb
+- lib/seria.rb
+- lib/seria/converters.rb
+- lib/seria/info_table.rb
+- lib/seria/version.rb
+- seria.gemspec
+- spec/converters_spec.rb
+homepage: ''
+licenses:
+- MIT
+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: ''
+test_files:
+- spec/converters_spec.rb