schemaless_field 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d076dbf9241157a017c5ac1518053079c8559553
+  data.tar.gz: e190ffdc90808e087b959cd0cae00c595ea8ba92
+SHA512:
+  metadata.gz: 1c61bd854ee55720a84564cb3f737188aac2355bc1314e579055fe89882dba47c3c81aae20aceed67fbf40000394452a2aa45ef73df3e47cc5a83b9bf19e8885
+  data.tar.gz: d55c2f5d0bb6c40768624e68e10a921693a377bda786e04661a99986bd46ea7006c308c3933e99bbd39128aaff849c79ad9197a12d91b1c95f7cf1e6ef7e29f7

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/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schemaless_field.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'guard-bundler'
+end

data/Guardfile

@@ -0,0 +1,20 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch('Gemfile')
+  # Uncomment next line if your Gemfile contains the `gemspec' command.
+  # watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+# guard :rubocop do
+#   watch(%r{.+\.rb$})
+#   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+# end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stan Bondi
+
+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,70 @@
+# SchemalessField
+
+Basic accessor methods for schemaless ORM fields.
+For e.g. a JSON field in Postgres.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'schemaless_field'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schemaless_field
+
+## Usage
+
+```ruby
+
+class Item < ActiveRecord::Base # Any class with a json string or hash can be used
+  after_initialize :set_data
+
+  json_attr :data do
+    f.field :color, '$..color' # explicit path (not required)
+    f.field :array             # implicit path
+    f.field :nested_field      # nested implicit path i.e: $..nested.field
+
+    f.first_thing, '$..things[0]' # explicit path
+  end
+
+  private
+
+  def set_data
+    self.data ||= {
+      color: 'red',
+      nested: {
+        field: true
+      },
+      things: [
+        {name: 'car'},
+        {name: 'laptop'}
+      ]
+    }
+  end
+
+end
+```
+
+Now some field accessors will be available
+
+```ruby
+
+  item = Item.new
+  item.color #= "red"
+  item.color = "blue" # data = { 'color' => 'blue', ... }
+  item.nested_field # true
+  item.first_thing # "car"
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/schemaless_field/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

data/Rakefile

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

data/lib/railtie.rb

@@ -0,0 +1,17 @@
+require "rails"
+
+module SchemalessField
+  class Railtie < Rails::Railtie # :nodoc:
+    config.eager_load_namespaces << SchemalessField
+
+    initializer "schemaless_field.initialize" do |app|
+      ActiveSupport.on_load(:active_record) do
+        include SchemalessField::DSL
+      end
+
+      ActiveSupport.on_load(:mongoid) do
+        raise "You do not need schemaless_field with mongoid."
+      end
+    end
+  end
+end

data/lib/schemaless_field/dsl.rb

@@ -0,0 +1,11 @@
+module SchemalessField
+  module DSL
+    def self.included(base)
+      base.class_eval do
+        def self.json_attr(attr)
+          yield Field.new(self, attr)
+        end
+      end
+    end
+  end
+end

data/lib/schemaless_field/field.rb

@@ -0,0 +1,50 @@
+module SchemalessField
+  class Field
+    attr_reader :model, :model_attr
+
+    def initialize(model, model_attr)
+      @model = model
+      @model_attr = model_attr
+    end
+
+    def field(attribute, path = nil)
+      path ||= path_from_attr(attribute)
+      mod = Module.new
+      model.send(:include, mod)
+      mod.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        # Getter
+        def #{attribute}
+          ::JsonPath.on(json__#{attribute}, '#{path}')[0]
+        end
+
+        # Setter
+        def #{attribute}=(value)
+          self.#{@model_attr} = ::JsonPath
+            .for(json__#{attribute})
+            .gsub('#{path}') { |v| value }
+            .to_hash
+        end
+
+        private
+
+        def json__#{attribute}
+          val = self.send(:#{@model_attr})
+          case val
+          when String
+            val
+          when Hash
+            val.deep_stringify_keys
+          end
+        end
+      RUBY
+    end
+
+    private
+
+    def path_from_attr(attribute)
+      "$..#{attribute.to_s.gsub('_', '.')}"
+    rescue
+      "$..#{attribute}"
+    end
+  end
+end

data/lib/schemaless_field/version.rb

@@ -0,0 +1,3 @@
+module SchemalessField
+  VERSION = "0.0.2"
+end

data/lib/schemaless_field.rb

@@ -0,0 +1,10 @@
+require 'jsonpath'
+require 'json'
+
+require "schemaless_field/version"
+require 'schemaless_field/dsl'
+require 'schemaless_field/field'
+
+require 'active_support/core_ext/hash'
+
+require 'railtie' if defined?(Rails)

data/schemaless_field.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schemaless_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schemaless_field"
+  spec.version       = SchemalessField::VERSION
+  spec.authors       = ["Stan Bondi"]
+  spec.email         = ["stan@fixate.it"]
+  spec.summary       = %q{Basic accessor methods for schemaless ORM fields.}
+  spec.description   = <<-TXT
+  Basic accessor methods for schemaless ORM fields.
+  For e.g. a JSON field in Postgres.
+  TXT
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "jsonpath", "~> 0.5.6"
+  spec.add_dependency "activesupport", "> 2"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/spec/dsl_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+class Dummy
+  attr_accessor :data
+  include SchemalessField::DSL
+
+  def initialize
+    self.data = {
+      lannisters: {
+        geoffrey: 'king',
+        cersei: 'queen regent',
+        tyrion: 'master of coin'
+      }
+    }
+  end
+end
+
+describe SchemalessField::DSL do
+  it 'creates and yields a new field' do
+    Dummy.json_attr :data do |f|
+      f.field :lannisters
+    end
+
+    dummy = Dummy.new
+    expect(dummy.lannisters).to eq(dummy.data['lannisters'])
+  end
+end
+

data/spec/field_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+class Dummy
+  attr_accessor :data
+
+  def initialize
+    self.data = {
+      foo: [1,2,3],
+      bar: '!!!',
+      nested: {
+        quite: 'deep'
+      },
+      complex: [
+        # These MUST BE string keys
+        {'name' => 'another', 'value' => 100},
+        {'name' => 'test', 'value' => 123}
+      ]
+    }
+  end
+end
+
+describe SchemalessField::Field do
+  subject { Dummy.new }
+  let(:field) { described_class.new(subject.class, :data) }
+
+  before { field.field :foo, '$..foo' }
+
+  it 'defines getter method on the model' do
+    expect(subject).to respond_to(:foo)
+  end
+
+  it 'defines getter method on the model' do
+    expect(subject).to respond_to(:"foo=")
+  end
+
+  it 'returns nil if path doesnt exist' do
+    field.field :not_existing_path
+    expect(subject.not_existing_path).to be_nil
+  end
+
+  it 'returns value from complex path' do
+    field.field :complex, '$..complex[?(@.name=="test")].value'
+    expect(subject.complex).to eq(123)
+  end
+
+  describe 'implicit path' do
+    before { field.field :nested_quite }
+    it 'finds field implicitly' do
+      expect(subject.nested_quite).to eq('deep')
+    end
+  end
+
+  describe 'getter' do
+    it 'gets data from the json' do
+      expect(subject.foo).to eq([1,2,3])
+    end
+
+    it 'gets deep data in json' do
+      field.field :nested_deep, '$..nested.quite'
+      expect(subject.nested_deep).to eq('deep')
+    end
+  end
+
+  describe 'setter' do
+    it 'sets data in json' do
+      subject.foo = 'haldo'
+      expect(subject.data['foo']).to eq('haldo')
+    end
+
+    it 'sets deep data in json' do
+      field.field :nested_deep, '$..nested.quite'
+      subject.nested_deep = 'shallow'
+      expect(subject.data['nested']['quite']).to eq('shallow')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'schemaless_field'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: schemaless_field
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stan Bondi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: |2
+    Basic accessor methods for schemaless ORM fields.
+    For e.g. a JSON field in Postgres.
+email:
+- stan@fixate.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/railtie.rb
+- lib/schemaless_field.rb
+- lib/schemaless_field/dsl.rb
+- lib/schemaless_field/field.rb
+- lib/schemaless_field/version.rb
+- schemaless_field.gemspec
+- spec/dsl_spec.rb
+- spec/field_spec.rb
+- spec/spec_helper.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.0
+signing_key: 
+specification_version: 4
+summary: Basic accessor methods for schemaless ORM fields.
+test_files:
+- spec/dsl_spec.rb
+- spec/field_spec.rb
+- spec/spec_helper.rb
+has_rdoc: