store_schema 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d13d481527cfe8e42df69d8c0ac8277a09d0b2f7
-  data.tar.gz: 4bfba69ec1c4ce763a544aa8eb1cdd3ec7aad8eb
+  metadata.gz: 5a05dab9a51e83ac7afde53a40dc65dddd2d388d
+  data.tar.gz: 9036c033e270aebcd9f08fd56da0b7553db09b67
 SHA512:
-  metadata.gz: 870cf0a943b7c6c27c8a11eb961b65ae05033471f76d755391baf1a7e8f88be8bd959c3b7d3a4faa0c3c323ef91119909414e5ef5099d08b8b463d6f5968a0d8
-  data.tar.gz: b8db099f6f49b350e53aa39483d7200db482b40f3deacab9b1151fff93ed9d5132de10d22e3f0e81122ae90ebe3f4202103851674ad9c9c12954637a0466d859
+  metadata.gz: 1c0a5cf4d0bf2a57a75c788aa619317fed9a7d5accedd181d027f6b9011b726d38a8c49389ab1e1a252668defa1c8f08b8a34ee281f21ce92962c5ba3610520c
+  data.tar.gz: c764b979e4d63d8ce23898e309200a0671102eba64a8a56255c8e434c6866a87f7dd11ed2d635bef9ae94eb806b323d85898680eed88fc79563292f094122e54

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - rbx-2.2
 gemfile:
   - .gemfiles/4.0.gemfile

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Michael van Rooijen
+Copyright (c) 2015 Michael van Rooijen
 
 MIT License
 

data/README.md

@@ -1,5 +1,6 @@
-# StoreSchema
+# Store Schema
 
+[![Gem Version](https://badge.fury.io/rb/store_schema.svg)](http://badge.fury.io/rb/store_schema)
 [![Code Climate](https://codeclimate.com/github/meskyanichi/store_schema.png)](https://codeclimate.com/github/meskyanichi/store_schema)
 [![Build Status](https://travis-ci.org/meskyanichi/store_schema.svg)](https://travis-ci.org/meskyanichi/store_schema)
 
@@ -7,6 +8,8 @@ StoreSchema, for Rails/ActiveRecord 4.0.0+, enhances `ActiveRecord::Base.store_a
 
 This library was developed for- and extracted from [HireFire].
 
+The documentation can be found on [RubyDoc].
+
 
 ### Compatibility
 
@@ -17,7 +20,7 @@ This library was developed for- and extracted from [HireFire].
 
 ### Installation
 
-Distributed at a gem, hosted at [RubyGems.org].
+Add the gem to your Gemfile and run `bundle`.
 
 ```rb
 gem "store_schema"
@@ -37,10 +40,13 @@ class Website < ActiveRecord::Base
   # Tell ActiveRecord that we want to serialize the :config attribute
   # and store the serialized data as text in the config column.
   #
-  # If you're using PostreSQL's "hstore" column-type instead of the
-  # "text" column-type, you don't have to define `serialize :config`.
+  # By default, `store` serializes your data as YAML. You can swap this out for
+  # any other coder you want. For example JSON or Oj (high performance JSON).
+  #
+  # If you're using PostgreSQL's hstore or json column-type instead of the
+  # text column-type, you should'nt define `store :config`.
   #
-  serialize :config
+  store :config, coder: JSON
 
   # Define a schema for the store. This syntax is similar to
   # ActiveRecord::Migration.
@@ -100,7 +106,8 @@ See above example.
 If you need to be able to query these serialized attributes,
 consider using [PostgreSQL's HStore Extension]. If you do not need to
 be able to query the serialized data, you can simply use a text-type column
-and use the `serialize` method in your model which works with any SQL database.
+and use the `store <column>[, coder: JSON]` method in your model which works
+with any SQL database.
 
 
 ### Contributing
@@ -134,6 +141,12 @@ rspec spec
 rubycritic lib
 ```
 
+To run the local documentation server:
+
+```
+yard server --reload
+```
+
 Create a new branch and start hacking:
 
 ```
@@ -145,13 +158,14 @@ Submit a pull request.
 
 ### Author / License
 
-Copyright (c) 2014 Michael van Rooijen ( [@meskyanichi] )<br />
+Copyright (c) 2015 Michael van Rooijen ( [@meskyanichi] )<br />
 Released under the MIT [License].
 
 [@meskyanichi]: https://twitter.com/meskyanichi
 [HireFire]: http://hirefire.io
 [Passing Specs]: https://travis-ci.org/meskyanichi/store_schema
 [Code Climate Score]: https://codeclimate.com/github/meskyanichi/store_schema
+[RubyDoc]: http://rubydoc.info/github/meskyanichi/store_schema/master/frames
 [License]: https://github.com/meskyanichi/store_schema/blob/master/LICENSE
 [RubyGems.org]: https://rubygems.org/gems/store_schema
 [PostgreSQL's HStore Extension]: http://www.postgresql.org/docs/9.3/static/hstore.html

data/lib/store_schema/accessor_definer.rb

@@ -1,5 +1,4 @@
 class StoreSchema::AccessorDefiner
-  class InvalidValueType < StandardError; end
 
   # @return [Class]
   #
@@ -64,25 +63,15 @@ class StoreSchema::AccessorDefiner
   # Enhances the store setter by adding data conversion capabilities.
   #
   def define_setter
-    _klass = klass
-    _column = column
     _type = type
-    _attribute = attribute
 
     klass.send(:define_method, "#{attribute}=") do |value|
-      if value.is_a?(NilClass)
-        super(value)
-      else
-        converted_value = StoreSchema::Converter
-          .new(value, _type).to_db
+      converted_value = StoreSchema::Converter.new(value, _type).to_db
 
-        if converted_value
-          super(converted_value)
-        else
-          raise InvalidValueType,
-            "#{value} (#{value.class}) for " +
-            "#{_klass}##{_column}.#{_attribute} (#{_type})"
-        end
+      if converted_value
+        super(converted_value)
+      else
+        super(nil)
       end
     end
   end

data/lib/store_schema/converter/base.rb

@@ -1,4 +1,4 @@
-module StoreSchema::Converter::Base
+class StoreSchema::Converter::Base
 
   # @return [Object]
   #

data/lib/store_schema/converter/boolean.rb

@@ -1,7 +1,6 @@
 require_relative "base"
 
-class StoreSchema::Converter::Boolean
-  include StoreSchema::Converter::Base
+class StoreSchema::Converter::Boolean < StoreSchema::Converter::Base
 
   # @return [String] the database representation of a true value.
   #

data/lib/store_schema/converter/date_time.rb

@@ -1,7 +1,6 @@
 require_relative "base"
 
-class StoreSchema::Converter::DateTime
-  include StoreSchema::Converter::Base
+class StoreSchema::Converter::DateTime < StoreSchema::Converter::Base
 
   # @return [String] the database format for storing a DateTime object.
   #

data/lib/store_schema/converter/float.rb

@@ -1,7 +1,6 @@
 require_relative "base"
 
-class StoreSchema::Converter::Float
-  include StoreSchema::Converter::Base
+class StoreSchema::Converter::Float < StoreSchema::Converter::Base
 
   # Converts the {#value} to a database-storable value.
   #

data/lib/store_schema/converter/integer.rb

@@ -1,7 +1,6 @@
 require_relative "base"
 
-class StoreSchema::Converter::Integer
-  include StoreSchema::Converter::Base
+class StoreSchema::Converter::Integer < StoreSchema::Converter::Base
 
   # Converts the {#value} to a database-storable value.
   #

data/lib/store_schema/converter/string.rb

@@ -1,7 +1,6 @@
 require_relative "base"
 
-class StoreSchema::Converter::String
-  include StoreSchema::Converter::Base
+class StoreSchema::Converter::String < StoreSchema::Converter::Base
 
   # Simply returns {#value} if it's a String.
   #

data/lib/store_schema/version.rb

@@ -1,3 +1,3 @@
 module StoreSchema
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/lib/{casted_store_accessor_spec.rb → store_schema_spec.rb}

@@ -19,12 +19,9 @@ RSpec.describe "StoreSchema" do
       expect(website.reload.name).to eq("Store Schema")
     end
 
-    it "does not accept invalid data types" do
-      expect { website.update_attribute(:name, true) }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "true (TrueClass) for Website#config.name (string)"
-        )
+    it "should convert to nil if incompatible type" do
+      website.update_attribute(:name, true)
+      expect(website.name).to eq(nil)
     end
   end
 
@@ -42,20 +39,14 @@ RSpec.describe "StoreSchema" do
       expect(website.visitors).to eq(1337)
     end
 
-    it "does not accept invalid string formats" do
-      expect { website.update_attribute(:visitors, "abc") }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "abc (String) for Website#config.visitors (integer)"
-        )
+    it "should convert to nil if incompatible value" do
+      website.update_attribute(:visitors, "abc")
+      expect(website.visitors).to eq(nil)
     end
 
-    it "does not accept invalid data types" do
-      expect { website.update_attribute(:visitors, true) }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "true (TrueClass) for Website#config.visitors (integer)"
-        )
+    it "should convert to nil if incompatible type" do
+      website.update_attribute(:visitors, true)
+      expect(website.visitors).to eq(nil)
     end
   end
 
@@ -85,20 +76,14 @@ RSpec.describe "StoreSchema" do
       expect(website.apdex).to eq(1.0)
     end
 
-    it "does not accept invalid string formats" do
-      expect { website.update_attribute(:apdex, "abc") }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "abc (String) for Website#config.apdex (float)"
-        )
+    it "should convert to nil if incompatible value" do
+      website.update_attribute(:apdex, "abc")
+      expect(website.apdex).to eq(nil)
     end
 
-    it "does not accept invalid data types" do
-      expect { website.update_attribute(:apdex, true) }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "true (TrueClass) for Website#config.apdex (float)"
-        )
+    it "should convert to nil if incompatible type" do
+      website.update_attribute(:apdex, true)
+      expect(website.apdex).to eq(nil)
     end
   end
 
@@ -118,12 +103,9 @@ RSpec.describe "StoreSchema" do
       end
     end
 
-    it "does not accept invalid data types" do
-      expect { website.update_attribute(:ssl, "abc") }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "abc (String) for Website#config.ssl (boolean)"
-        )
+    it "should convert to nil if incompatible type" do
+      website.update_attribute(:ssl, "abc")
+      expect(website.ssl).to eq(nil)
     end
   end
 
@@ -153,20 +135,14 @@ RSpec.describe "StoreSchema" do
       expect(website.published_at.class).to eq(DateTime)
     end
 
-    it "does not accept invalid string formats" do
-      expect { website.update_attribute(:published_at, "abc") }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "abc (String) for Website#config.published_at (datetime)"
-        )
+    it "should convert to nil if incompatible value" do
+      website.update_attribute(:published_at, "abc")
+      expect(website.published_at).to eq(nil)
     end
 
-    it "does not accept invalid data types" do
-      expect { website.update_attribute(:published_at, true) }
-        .to raise_error(
-          StoreSchema::AccessorDefiner::InvalidValueType,
-          "true (TrueClass) for Website#config.published_at (datetime)"
-        )
+    it "should convert to nil if incompatible type" do
+      website.update_attribute(:published_at, true)
+      expect(website.published_at).to eq(nil)
     end
   end
 end

data/spec/spec_helper.rb

@@ -9,13 +9,6 @@ require "store_schema"
 require File.expand_path("../support/models", __FILE__)
 
 RSpec.configure do |config|
-  config.mock_framework = :mocha
-
-  config.before do
-    DatabaseCleaner.start
-  end
-
-  config.after do
-    DatabaseCleaner.clean
-  end
+  config.before { DatabaseCleaner.start }
+  config.after { DatabaseCleaner.clean }
 end

data/spec/support/db.rb

@@ -1,4 +1,3 @@
-ActiveRecord::Base.logger = Logger.new(LOG_PATH)
 ActiveRecord::Base.establish_connection(
   adapter: "sqlite3", database: ":memory:"
 )

data/spec/support/env.rb

@@ -1,14 +1,8 @@
-require "fileutils"
-require "logger"
 require "pry"
 require "sqlite3"
 require "active_record"
 
 ROOT_PATH = File.expand_path("../../..", __FILE__)
 SPEC_PATH = File.join(ROOT_PATH, "spec")
-TMP_PATH = File.join(ROOT_PATH, "tmp")
-LOG_PATH = File.join(TMP_PATH, "store_schema.log")
-
-FileUtils.mkdir_p(TMP_PATH)
 
 require "#{SPEC_PATH}/support/db"

data/spec/support/models.rb

@@ -1,6 +1,6 @@
 class Website < ActiveRecord::Base
 
-  serialize :config
+  store :config, coder: JSON
 
   store_schema :config do |s|
     s.string :name

data/store_schema.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "mocha"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: store_schema
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-19 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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
@@ -179,7 +165,7 @@ files:
 - lib/store_schema/converter/string.rb
 - lib/store_schema/module.rb
 - lib/store_schema/version.rb
-- spec/lib/casted_store_accessor_spec.rb
+- spec/lib/store_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/db.rb
 - spec/support/env.rb
@@ -205,12 +191,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Enhances ActiveRecord::Base.store_accessor with data conversion capabilities.
 test_files:
-- spec/lib/casted_store_accessor_spec.rb
+- spec/lib/store_schema_spec.rb
 - spec/spec_helper.rb
 - spec/support/db.rb
 - spec/support/env.rb