serialized_virtual_attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 18067bd9816c2051700b797175601460e56ff152
+  data.tar.gz: e1a0fb1b60d17a94517c349aca9bc53890f7951d
+SHA512:
+  metadata.gz: 04497741cbdb94afd23c6eae9b7fed7ad84734772ace40fdbec289c83967421e4b9037fa96082f9f4e3f81616a4788734085658625f7621fcd5ea6488f361063
+  data.tar.gz: 359f9003f757ef2afd6153ccbb99b39c5408f7a0abf78eb5e107ee99f6806b4ee517a0eddfcdccec8404bff10ec9754daba0240c2df4305adf019402303d6aa1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/db/*.sqlite

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sergey.Gnuskov
+
+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,66 @@
+# SerializedVirtualAttributes
+
+This gem provides ability to have several attributes in one ActiveRecord serialized column. It might be useful for STI classes, that have some different attributes and you don't want to have separate columns for each class.
+
+## Requirements
+
+This gem requires ActiveRecord 3.0 or higher and ruby 1.9 or higher.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serialized_virtual_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serialized_virtual_attributes
+
+## Usage
+
+Just create text column, serialize it to `Hash` and define your virtual attributes using `serialized_virtual_attribute`:
+```ruby
+  class Server < ActiveRecord::Base
+    serialize :configuration, Hash
+
+    # basic attributes
+    serialized_virtual_attribute :host, :description, to: :configuration
+
+    # attribute with typecast
+    serialized_virtual_attribute :port, to: :configuration, typecast: Integer
+
+    # attributes with prefixed accessors
+    serialized_virtual_attribute :name, to: :configuration, prefix: :network
+  end
+```
+Then you are able to use accessors:
+
+```ruby
+  serv = Server.new
+  serv.host = 'localhost'
+  serv.port = 9232
+  serv.network_name = 'oxygen'
+```
+
+For ActiveRecord < 4 attr_accessible is enabled by default. You can disable it by providing `accessible: false`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/serialized_virtual_attributes.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "serialized_virtual_attributes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/serialized_virtual_attributes.rb

@@ -0,0 +1,70 @@
+require "serialized_virtual_attributes/version"
+require 'active_support'
+
+module SerializedVirtualAttributes
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :serialized_virtual_attributes
+  end
+
+  module ClassMethods
+    def serialized_virtual_attribute(*args)
+      options = args.extract_options!
+      to = options[:to]
+      raise ArgumentError.new("option 'to' not provided or it is not serialized to hash") if to.blank? or self.serialized_attributes[to.to_s].try(:object_class) != Hash
+
+      typecast = options[:typecast]
+
+      self.serialized_virtual_attributes ||= {}
+      self.serialized_virtual_attributes[to] ||= Set.new
+
+      prefix = options[:prefix]
+
+      args.each do |a|
+        accessor_name = prefix.blank? ? a : :"#{prefix}_#{a}"
+        self.serialized_virtual_attributes[to] += [accessor_name]
+        class_eval "
+          def #{accessor_name}
+            self.#{to} = {} if self.#{to}.blank?
+
+            self.#{to}[:#{a}]
+          end
+        "
+
+        if typecast.blank?
+          class_eval "
+            def #{accessor_name}=(value)
+              self.#{to} = {} if self.#{to}.blank?
+
+              #{to}_will_change! unless value == self.#{to}[:#{a}]
+
+              self.#{to}[:#{a}] = value
+            end
+          "
+        else
+          class_eval "
+            def #{accessor_name}=(value)
+              self.#{to} = {} if self.#{to}.blank?
+
+              value = #{typecast.name}(value) rescue nil
+              #{to}_will_change! unless value == self.#{to}[:#{a}]
+
+              self.#{to}[:#{a}] = value
+            end
+          "
+        end
+
+        unless ActiveRecord::VERSION::MAJOR >= 4 or options[:accessible] == false
+          class_eval "
+            attr_accessible :#{accessor_name}
+          "
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load :active_record do
+  ActiveRecord::Base.send :include, ::SerializedVirtualAttributes
+end

data/lib/serialized_virtual_attributes/version.rb

@@ -0,0 +1,3 @@
+module SerializedVirtualAttributes
+  VERSION = "0.1.0"
+end

data/serialized_virtual_attributes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serialized_virtual_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serialized_virtual_attributes"
+  spec.version       = SerializedVirtualAttributes::VERSION
+  spec.authors       = ["Sergey.Gnuskov"]
+  spec.email         = ["sergey.gnuskov@flant.ru"]
+
+  spec.summary       = %q{Ability to have several activerecord-like attributes in a single serialized column}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_runtime_dependency "activerecord", ">= 3.2"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: serialized_virtual_attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey.Gnuskov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- sergey.gnuskov@flant.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/serialized_virtual_attributes.rb
+- lib/serialized_virtual_attributes/version.rb
+- serialized_virtual_attributes.gemspec
+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: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Ability to have several activerecord-like attributes in a single serialized
+  column
+test_files: []