opium 1.0.0.beta → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7949dfc491925078b8d64f4b093524530d183608
-  data.tar.gz: d9949725cb81e568d62bd46c1be3fb28af0c2b08
+  metadata.gz: ab3129797b81cdb23362431fddf4ee5d6deaf1d9
+  data.tar.gz: a6f8105866f4101f9f4eb2f0661696777846741b
 SHA512:
-  metadata.gz: 012d1e38fab68ab65636e981b5c06861dd6acdee6e4d0d025ee9ac72b6a9c7216e3fd15e4a9b999adff35fcb706253520f78d5fda386430240ad31511d67b6a3
-  data.tar.gz: 496fd7162e76f218f08caaa37cb300bb3662843577c4c77f4cb31ab98e00f8f34606cab80540ba482c9bda15fc0069c429284f584c5f98bd7db0cb36e50ed462
+  metadata.gz: 0047e98730f67c24d819a704c9a22f1f89e8f686bf2c7be9dbc4c1a7eadbeae8f63e897a315dfff72e3c58bfd0db07f08a5977b395f43b1a79f5498cf9de7808
+  data.tar.gz: 7f34b3d49b52392291584f1b9c1e33b9be7b6273d4a2aca50234bb05a1f70ebe44113e7944629ab145f93a08d03923caa245134f543022e9cb9d25861656f6a1

data/README.md

@@ -2,6 +2,7 @@
 
 Provides an intuitive, Mongoid-inspired mapping layer between your application's object space and Parse.
 
+[![Gem Version](https://badge.fury.io/rb/opium.svg)](http://badge.fury.io/rb/opium)
 [![Build Status](https://travis-ci.org/joshuabowers/opium.svg?branch=master)](https://travis-ci.org/joshuabowers/opium)
 [![Coverage Status](https://img.shields.io/coveralls/joshuabowers/opium.svg)](https://coveralls.io/r/joshuabowers/opium)
 [![Code Climate](https://codeclimate.com/github/joshuabowers/opium/badges/gpa.svg)](https://codeclimate.com/github/joshuabowers/opium)

data/lib/generators/opium/user_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'generators/opium/model_generator'
+
+module Opium
+  module Generators
+    class UserGenerator < ::Rails::Generators::Base
+      desc "Creates an Opium user model"
+      
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+      
+      def run_model_generator
+        generate 'model', *['user', *attributes, '--parent=opium/user']
+      end
+    end
+  end
+end

data/lib/opium/model/connectable.rb

@@ -85,6 +85,8 @@ module Opium
           !@requires_heightened_privileges.nil?
         end
         
+        alias_method :has_heightened_privileges?, :requires_heightened_privileges?
+        
         private
                 
         def http( method, options, &block )

data/lib/opium/model/inheritable.rb

@@ -0,0 +1,27 @@
+module Opium
+  module Model
+    module Inheritable
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        def inherited( subclass )
+          self.resource_name
+          
+          [
+            :@ruby_canonical_field_names, 
+            :@parse_canonical_field_names, 
+            :@object_prefix, 
+            :@added_headers, 
+            :@requires_heightened_privileges,
+            :@fields,
+            :@resource_name
+          ].each do |iv|
+            origin = self.instance_variable_get( iv )
+            can_copy = ![TrueClass, FalseClass, NilClass].include?( origin.class )
+            subclass.instance_variable_set( iv, can_copy ? origin.dup : origin )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opium/model.rb

@@ -14,6 +14,7 @@ require 'opium/model/queryable'
 require 'opium/model/criteria'
 require 'opium/model/scopable'
 require 'opium/model/findable'
+require 'opium/model/inheritable'
 require 'opium/model/kaminari'
 
 module Opium
@@ -33,6 +34,7 @@ module Opium
       include Callbacks
       include Scopable
       include Findable
+      include Inheritable
     end
     
     def initialize( attributes = {} )

data/lib/opium/version.rb

@@ -1,3 +1,3 @@
 module Opium
-  VERSION = "1.0.0.beta"
+  VERSION = "1.0.0"
 end

data/opium.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Joshua Bowers"]
   spec.email         = ["joshua.bowers+code@gmail.com"]
   spec.summary       = %q{An Object Parse.com Mapping technology for defining models.}
-  spec.description   = %q{Provides an intuitive, Mongoid-inspired mapping layer between your application's object space and Parse.'}
+  spec.description   = %q{Provides an intuitive, Mongoid-inspired mapping layer between your application's object space and Parse.}
   spec.homepage      = "https://github.com/joshuabowers/opium"
   spec.license       = "MIT"
 
@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "coveralls"
   
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "kaminari"
+  # spec.add_development_dependency "rails"
+  # spec.add_development_dependency "kaminari"
   
   spec.add_dependency "activemodel", "~> 4.0"
   spec.add_dependency "faraday", "~> 0.9"

data/spec/opium/model/connectable_spec.rb

@@ -20,7 +20,7 @@ describe Opium::Model::Connectable do
   it { is_expected.to respond_to( :as_resource, :resource_name ).with(1).argument }
   it { is_expected.to respond_to( :http_get, :http_post, :http_delete ).with(1).argument }
   it { is_expected.to respond_to( :http_put ).with(2).arguments }
-  it { is_expected.to respond_to( :requires_heightened_privileges!, :requires_heightened_privileges? ) }
+  it { is_expected.to respond_to( :requires_heightened_privileges!, :requires_heightened_privileges?, :has_heightened_privileges? ) }
   
   describe '.object_prefix' do
     it { expect( subject.object_prefix ).to eq 'classes' }

data/spec/opium/model/inheritable_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Opium::Model::Inheritable do
+  before do
+    stub_const( 'Model', Class.new do
+      include Opium::Model::Inheritable
+    end )
+  end
+  
+  subject { Model }
+  
+  it { expect( subject ).to respond_to( :inherited ).with(1).argument }
+  
+  context 'within a subclass' do
+    before do
+      stub_const( 'Game', Class.new do
+        include Opium::Model
+        field :title, type: String
+        field :price, type: Float
+        
+        no_object_prefix!
+        requires_heightened_privileges!
+      end )
+      stub_const( 'MobileGame', Class.new( Game ) do
+        field :device, type: String
+      end )
+    end
+    
+    subject { MobileGame }
+    
+    it { is_expected.to be <= Game }
+    
+    it { expect( subject.object_prefix ).to eq subject.superclass.object_prefix }
+    it { expect( subject.ruby_canonical_field_names ).to include( subject.superclass.ruby_canonical_field_names ) }
+    it { expect( subject.parse_canonical_field_names ).to include( subject.superclass.parse_canonical_field_names ) }
+    it { expect( subject.added_headers ).to include( subject.superclass.added_headers ) }
+    it { expect( subject.resource_name ).to eq subject.superclass.resource_name }
+    it { is_expected.to have_heightened_privileges }
+    
+    it { expect( subject ).to respond_to( :field, :fields ) }
+    
+    it "inherits its parent's fields" do
+      expect( subject.fields.keys ).to include( 'title', 'price' ) 
+    end
+    
+    it 'has its own defined fields' do
+      expect( subject.fields.keys ).to include( 'device' ) 
+    end
+    
+    it "does not alter its parent's fields" do
+      expect( Game.fields.keys ).to_not include( 'device' )
+    end
+        
+    it 'has accessors and mutators for its fields' do
+      expect( subject.new ).to respond_to( :title, :title=, :price, :price=, :device, :device= ) 
+    end
+    
+    it 'has its own canonical_field_names' do
+      expect( subject.ruby_canonical_field_names.keys ).to include( 'device' )
+      expect( subject.parse_canonical_field_names.keys ).to include( 'device' )
+    end
+    
+    it "does not alter its parent's canonical_field_names" do
+      expect( Game.ruby_canonical_field_names.keys ).to_not include( 'device' )
+      expect( Game.parse_canonical_field_names.keys ).to_not include( 'device' )
+    end
+  end
+end

data/spec/opium/model_spec.rb

@@ -12,38 +12,29 @@ describe Opium::Model do
   
   subject { Event }
   
-  it { should respond_to( :model_name, :validates, :define_model_callbacks ) }
-  it { should respond_to( :field ).with(2).arguments }
-  it { should respond_to( :delete_all, :find ).with(1).argument }
-  it { should respond_to( :connection ) }
-  it { should respond_to( :human_attribute_name, :lookup_ancestors ) }
-  
-  describe 'instance' do
-    subject { Event.new }
-    
-    it { should respond_to( :attributes ) }
-    it { should respond_to( :serializable_hash, :as_json, :from_json ) }
-    it { should respond_to( :changes, :changed? ) }
-    it { should respond_to( :inspect ) }
-    it { should respond_to( :to_key, :to_model ) }
+  it { is_expected.to be <= Opium::Model::Connectable }
+  it { is_expected.to be <= Opium::Model::Persistable }
+  it { is_expected.to be <= Opium::Model::Dirty }
+  it { is_expected.to be <= Opium::Model::Fieldable }
+  it { is_expected.to be <= Opium::Model::Serialization }
+  it { is_expected.to be <= Opium::Model::Attributable }
+  it { is_expected.to be <= Opium::Model::Queryable }
+  it { is_expected.to be <= Opium::Model::Callbacks }
+  it { is_expected.to be <= Opium::Model::Scopable }
+  it { is_expected.to be <= Opium::Model::Findable }
+  it { is_expected.to be <= Opium::Model::Inheritable }
     
-    its(:attributes) do
-      should_not be_nil
-      should be_a_kind_of( Hash )
-    end
-  end
-  
-  describe 'inspect' do
-    describe 'within a blank model' do
+  describe '#inspect' do
+    context 'within a blank model' do
       subject { Event.new }
       
-      it { subject.inspect.should == '#<Event id: nil, created_at: nil, updated_at: nil, name: nil, occurred_at: nil, severe: nil>' }
+      it { expect( subject.inspect ).to eq '#<Event id: nil, created_at: nil, updated_at: nil, name: nil, occurred_at: nil, severe: nil>' }
     end
     
-    describe 'within a model with data' do
+    context 'within a model with data' do
       let(:event_time) { Time.now }
       subject { Event.new id: 'abc123', name: 'ping', occurred_at: event_time, severe: false }
-      it { subject.inspect.should == "#<Event id: \"abc123\", created_at: nil, updated_at: nil, name: \"ping\", occurred_at: #{event_time.to_datetime.inspect}, severe: false>" }
+      it { expect( subject.inspect ).to eq "#<Event id: \"abc123\", created_at: nil, updated_at: nil, name: \"ping\", occurred_at: #{event_time.to_datetime.inspect}, severe: false>" }
     end
   end
 end

data/spec/opium/user_spec.rb

@@ -192,4 +192,22 @@ describe Opium::User do
   
   it_behaves_like 'a varying privileges user', :save, [:put, :update]
   it_behaves_like 'a varying privileges user', :delete, [:delete, :delete]
+  
+  context 'within a subclass' do
+    before do
+      stub_const( 'SpecialUser', Class.new(Opium::User) do
+        field :has_web_access, type: Boolean
+      end )
+    end
+    
+    subject { SpecialUser }
+    
+    it { is_expected.to be <= Opium::User }
+    it { is_expected.to respond_to( :field, :fields ) }
+    it { expect( subject.fields.keys ).to include( 'username', 'password', 'email', 'has_web_access' ) }
+    
+    it { expect( subject ).to have_heightened_privileges }
+    it { expect( subject.object_prefix ).to be_empty }
+    it { expect( subject.resource_name ).to eq 'users' }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opium
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta
+  version: 1.0.0
 platform: ruby
 authors:
 - Joshua Bowers
@@ -178,34 +178,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: 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'
-- !ruby/object:Gem::Dependency
-  name: kaminari
-  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: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -249,7 +221,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Provides an intuitive, Mongoid-inspired mapping layer between your application's
-  object space and Parse.'
+  object space and Parse.
 email:
 - joshua.bowers+code@gmail.com
 executables: []
@@ -268,6 +240,7 @@ files:
 - lib/generators/opium/model_generator.rb
 - lib/generators/opium/templates/config.yml
 - lib/generators/opium/templates/model.rb
+- lib/generators/opium/user_generator.rb
 - lib/opium.rb
 - lib/opium/config.rb
 - lib/opium/extensions.rb
@@ -296,6 +269,7 @@ files:
 - lib/opium/model/field.rb
 - lib/opium/model/fieldable.rb
 - lib/opium/model/findable.rb
+- lib/opium/model/inheritable.rb
 - lib/opium/model/kaminari.rb
 - lib/opium/model/kaminari/queryable.rb
 - lib/opium/model/kaminari/scopable.rb
@@ -329,6 +303,7 @@ files:
 - spec/opium/model/dirty_spec.rb
 - spec/opium/model/fieldable_spec.rb
 - spec/opium/model/findable_spec.rb
+- spec/opium/model/inheritable_spec.rb
 - spec/opium/model/kaminari/queryable_spec.rb
 - spec/opium/model/kaminari/scopable_spec.rb
 - spec/opium/model/kaminari_spec.rb
@@ -355,9 +330,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6
@@ -387,6 +362,7 @@ test_files:
 - spec/opium/model/dirty_spec.rb
 - spec/opium/model/fieldable_spec.rb
 - spec/opium/model/findable_spec.rb
+- spec/opium/model/inheritable_spec.rb
 - spec/opium/model/kaminari/queryable_spec.rb
 - spec/opium/model/kaminari/scopable_spec.rb
 - spec/opium/model/kaminari_spec.rb