opium 1.0.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7949dfc491925078b8d64f4b093524530d183608
+  data.tar.gz: d9949725cb81e568d62bd46c1be3fb28af0c2b08
+SHA512:
+  metadata.gz: 012d1e38fab68ab65636e981b5c06861dd6acdee6e4d0d025ee9ac72b6a9c7216e3fd15e4a9b999adff35fcb706253520f78d5fda386430240ad31511d67b6a3
+  data.tar.gz: 496fd7162e76f218f08caaa37cb300bb3662843577c4c77f4cb31ab98e00f8f34606cab80540ba482c9bda15fc0069c429284f584c5f98bd7db0cb36e50ed462

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store
+local/

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - 2.2.0
+  
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - joshua.bowers+code@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: "bundle exec rspec" do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+  
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Bowers
+
+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,71 @@
+# Opium
+
+Provides an intuitive, Mongoid-inspired mapping layer between your application's object space and Parse.
+
+[![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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opium'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opium
+
+## Usage
+
+### Within Rails
+
+Opium will automatically establish itself as the default ORM for Rails.
+
+#### ORM Configuration
+
+Create a config file to communicate with your Parse database by running the config generator:
+
+```bash
+$ rails g opium:config
+```
+
+See the generated file at `config/opium.yml` for more details
+
+#### Model Generator
+
+A generator exists for creating new models; this should be invoked whenever `rails g model` gets invoked.
+
+```bash
+$ rails g model game title:string price:float
+```
+
+### Specifying a model
+
+Models are defined by mixing in `Opium::Model` into a new class. Class names should match the names of the
+classes defined within Parse. You can define fields on your model which mirror the columns within a Parse
+class.
+
+```ruby
+class Game
+  include Opium::Model
+  
+  field :title, type: String
+  field :price, type: Float
+end
+```
+
+All models automatically come with three fields: *:id*, *:created_at*, and *:updated_at*. Field names are
+converted from a native ruby snake_case naming convention to a Parse lowerCamel convention.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/opium/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = %w[--color --format documentation]
+end
+
+task default: :spec

data/lib/generators/opium/config_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module Opium
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      source_root File.expand_path( "../templates/", __FILE__ )
+      
+      desc "Creates an Opium configuration file at config/opium.yml"
+      
+      def create_config_file
+        copy_file 'config.yml', File.join( 'config', 'opium.yml' )
+      end
+    end
+  end
+end

data/lib/generators/opium/model_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators/named_base'
+
+module Rails
+  module Generators
+    class GeneratedAttribute
+      def type_class
+        type.to_s.camelcase
+      end
+    end
+  end
+end
+
+module Opium
+  module Generators
+    class ModelGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path( "../templates/", __FILE__ )
+      
+      desc "Creates an Opium model"
+      
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+      
+      check_class_collision
+      
+      class_option :parent, type: :string, desc: "The parent model for the generated model when using STI"
+      
+      def create_model_file
+        template "model.rb", File.join( "app/models", class_path, "#{file_name}.rb" )
+      end
+      
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/opium/templates/config.yml

@@ -0,0 +1,27 @@
+development:
+  # The Application ID for your Parse app. Mandatory
+  app_id: PARSE-APP-ID
+    
+  # The REST API key for your Parse app. Mandatory
+  api_key: PARSE-API-KEY
+    
+  # Your Parse app's master key setting. You may omit this, 
+  # but you will be unable to edit Users except by ACL rules
+  master_key: PARSE-MASTER-KEY
+    
+  # Any communications done with parse will either be (true) displayed or (false) silenced
+  log_network_responses: true
+    
+test:
+  app_id: PARSE-TEST-APP-ID
+  api_key: PARSE-TEST-API-KEY
+  master_key: PARSE-TEST-MASTER-KEY
+  log_network_responses: true
+
+# You could hardcode the values for the production Parse app here, but it is suggested
+# you set these through the suggested environment variables.
+production:
+  app_id: <%= ENV['PARSE_APP_ID'] %>
+  api_key: <%= ENV['PARSE_API_KEY'] %>
+  master_key: <%= ENV['PARSE_MASTER_KEY'] %>
+  log_network_responses: false

data/lib/generators/opium/templates/model.rb

@@ -0,0 +1,10 @@
+<% module_namespacing do -%>
+class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent] %>
+<% unless options[:parent] -%>
+  include Opium::Model
+<% end -%>
+<% attributes.reject {|attr| attr.reference?}.each do |attribute| -%>
+  field :<%= attribute.name %><%= ", type: #{ attribute.type_class }" if attribute.type_class %>
+<% end -%>
+end
+<% end -%>

data/lib/opium/config.rb

@@ -0,0 +1,44 @@
+module Opium
+  extend self
+  
+  def configure
+    yield config
+  end
+
+  def config
+    @config ||= Opium::Config.new
+  end
+  
+  def load!( path, environment = nil )
+    settings = load_yaml( path, environment )
+    configure do |config|
+      settings.each do |key, value|
+        config.send("#{key}=", value)
+      end
+    end
+  end
+  
+  def reset
+    @config = nil
+  end
+  
+  private
+
+  def load_yaml( path, environment = nil )
+    env = environment ? environment.to_s : env_name
+    YAML.load(ERB.new(File.new(path).read).result)[env]
+  end
+
+  def env_name
+    defined?( Rails ) ? Rails.env : ( ENV["RACK_ENV"] || ENV["OPIUM_ENV"] || raise( "Could not determine environment" )  )
+  end
+    
+  class Config
+    include ActiveSupport::Configurable
+    
+    config_accessor( :app_id ) { 'PARSE_APP_ID' }
+    config_accessor( :api_key ) { 'PARSE_API_KEY' }
+    config_accessor( :master_key ){ 'PARSE_MASTER_KEY' }
+    config_accessor( :log_network_responses ) { false }
+  end
+end

data/lib/opium/extensions/array.rb

@@ -0,0 +1,10 @@
+class Array
+  def to_parse
+    map {|value| value.to_parse}
+  end
+  
+  def to_geo_point
+    return GeoPoint.new(self) if self.size == 2
+    fail ArgumentError, %(invalid value for GeoPoint: "#{ self.inspect }"), caller
+  end
+end

data/lib/opium/extensions/boolean.rb

@@ -0,0 +1,13 @@
+module Boolean
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def to_ruby(object)
+      object.to_bool if object.respond_to?( :to_bool )
+    end
+    
+    alias_method :to_parse, :to_ruby
+  end
+
+  extend ClassMethods
+end

data/lib/opium/extensions/date.rb

@@ -0,0 +1,18 @@
+class Date
+  def to_parse
+    {
+      '__type' => 'Date',
+      'iso' => self.iso8601
+    }
+  end
+  
+  class << self
+    def to_ruby(object)
+      object.to_date if object
+    end
+    
+    def to_parse(object)
+      object.to_date.to_parse if object
+    end
+  end
+end

data/lib/opium/extensions/date_time.rb

@@ -0,0 +1,18 @@
+class DateTime < Date
+  def to_parse
+    {
+      '__type' => 'Date',
+      'iso' => self.iso8601
+    }
+  end
+  
+  class << self
+    def to_ruby(object)
+      object.to_datetime if object
+    end
+    
+    def to_parse(object)
+      object.to_datetime.to_parse if object
+    end
+  end
+end

data/lib/opium/extensions/false_class.rb

@@ -0,0 +1,7 @@
+class FalseClass
+  include Boolean
+  
+  def to_bool
+    self
+  end
+end

data/lib/opium/extensions/float.rb

@@ -0,0 +1,13 @@
+class Float
+  class << self
+    def to_ruby(object)
+      if object.is_a? Symbol
+        object.to_s.to_f
+      elsif object
+        object.to_f
+      end
+    end
+    
+    alias_method :to_parse, :to_ruby
+  end
+end

data/lib/opium/extensions/geo_point.rb

@@ -0,0 +1,37 @@
+class GeoPoint
+  def initialize( value )
+    self.latitude, self.longitude = *
+      case value
+      when Hash
+        [value[:latitude] || value['latitude'], value[:longitude] || value['longitude']]
+      when Array
+        [value.first, value.last]
+      else
+        raise ArgumentError.new( "invalid value for GeoPoint: \"#{value}\"" )
+      end
+  end
+  
+  attr_accessor :latitude, :longitude
+  
+  def to_geo_point
+    self
+  end
+  
+  def to_parse
+    { "__type" => "GeoPoint", "latitude" => self.latitude, "longitude" => self.longitude }
+  end
+  
+  def to_s
+    "#{self.latitude},#{self.longitude}"
+  end
+
+  class << self
+    def to_ruby(object)
+      object.to_geo_point unless object.nil?
+    end
+    
+    def to_parse(object)
+      object.to_geo_point.to_parse
+    end
+  end
+end

data/lib/opium/extensions/hash.rb

@@ -0,0 +1,43 @@
+class Hash
+  def to_geo_point
+    return GeoPoint.new(self) if [:latitude, :longitude].all? {|required| self.key? required}
+    raise ArgumentError.new( "invalid value for GeoPoint: \"#{self}\"" )
+  end
+  
+  def to_datetime
+    retrieve_iso_key.to_datetime
+  end
+  
+  def to_date
+    retrieve_iso_key.to_date
+  end
+  
+  def to_time
+    retrieve_iso_key.to_time
+  end
+  
+  def to_parse
+    Hash[ *self.flat_map {|key, value| [key, value.to_parse]} ]
+  end
+  
+  private
+  
+  def retrieve_iso_key
+    validates_keys_present( '__type', 'iso' )
+    validate_key_equals( '__type', 'Date' )
+    value_for_indifferent_key('iso')
+  end
+  
+  def validates_keys_present(*expected_keys)
+    result = expected_keys - self.keys.map(&:to_s)
+    raise ArgumentError, "expected key(s): #{result}" unless result.empty?
+  end
+  
+  def validate_key_equals( key, value )
+    raise ArgumentError, "conversion to Date/Time expectes a #{key} of #{value}" unless value_for_indifferent_key( key ) == value
+  end
+  
+  def value_for_indifferent_key( key )
+    self[key] || self[key.to_sym]
+  end
+end

data/lib/opium/extensions/integer.rb

@@ -0,0 +1,13 @@
+class Integer
+  class << self
+    def to_ruby(object)
+      if object.is_a? Symbol
+        object.to_s.to_i
+      elsif object
+        object.to_i
+      end
+    end
+    
+    alias_method :to_parse, :to_ruby
+  end
+end

data/lib/opium/extensions/numeric.rb

@@ -0,0 +1,7 @@
+class Numeric
+  def to_bool
+    return true if self == 1
+    return false if self == 0
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+end

data/lib/opium/extensions/object.rb

@@ -0,0 +1,15 @@
+class Object
+  def to_ruby
+    self
+  end
+  
+  alias_method :to_parse, :to_ruby
+  
+  class << self
+    def to_ruby(other)
+      other
+    end
+    
+    alias_method :to_parse, :to_ruby
+  end
+end

data/lib/opium/extensions/pointer.rb

@@ -0,0 +1,20 @@
+module Opium
+  class Pointer
+    def initialize( attributes = {} )
+      self.class_name = attributes[:class_name] || attributes[:model_name] || (attributes[:class] || attributes[:model]).model_name
+      self.id = attributes[:id]
+    end
+    
+    attr_reader :class_name, :id
+    alias_method :model_name, :class_name
+    
+    def to_parse
+      { __type: 'Pointer', className: class_name, objectId: id }.with_indifferent_access
+    end
+    
+    private
+    
+    attr_writer :class_name, :id
+    alias_method :model_name=, :class_name=
+  end
+end

data/lib/opium/extensions/regexp.rb

@@ -0,0 +1,12 @@
+class Regexp
+  def to_parse
+    { '$regex' => self.source }.tap do |h|
+      ops = ''
+      { IGNORECASE => 'i', MULTILINE => 'm', EXTENDED => 'x' }.each do |option, value|
+        ops += value unless ( self.options & option ) == 0
+      end
+      
+      h['$options'] = ops unless ops.blank?
+    end
+  end
+end

data/lib/opium/extensions/string.rb

@@ -0,0 +1,20 @@
+class ::String
+  def to_bool
+    return true if self == true || self =~ (/^(true|t|yes|y|1)$/i)
+    return false if self == false || self.blank? || self =~ (/^(false|f|no|n|0)$/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+  
+  def to_geo_point
+    return GeoPoint.new( self.split(',').map {|c| c.to_f} ) if self =~ /^[+-]?\d+(\.\d+)?\s*,\s*[+-]?\d+(\.\d+)?$/
+    raise ArgumentError.new("invalid value for GeoPoint: \"#{self}\"")
+  end
+  
+  class << self
+    def to_ruby(object)
+      object.to_s if object
+    end
+    
+    alias_method :to_parse, :to_ruby
+  end
+end

data/lib/opium/extensions/time.rb

@@ -0,0 +1,19 @@
+class Time
+  def to_parse
+    {
+      '__type' => 'Date',
+      'iso' => self.iso8601
+    }
+  end
+  
+  class << self
+    def to_ruby(object)
+      object = object.utc if object.respond_to? :utc
+      object.to_time if object
+    end
+    
+    def to_parse(object)
+      object.to_time.to_parse if object
+    end
+  end
+end

data/lib/opium/extensions/true_class.rb

@@ -0,0 +1,7 @@
+class TrueClass
+  include Boolean
+  
+  def to_bool
+    self
+  end
+end

data/lib/opium/extensions.rb

@@ -0,0 +1,16 @@
+require 'opium/extensions/object'
+require 'opium/extensions/string'
+require 'opium/extensions/numeric'
+require 'opium/extensions/float'
+require 'opium/extensions/integer'
+require 'opium/extensions/boolean'
+require 'opium/extensions/true_class'
+require 'opium/extensions/false_class'
+require 'opium/extensions/geo_point'
+require 'opium/extensions/hash'
+require 'opium/extensions/array'
+require 'opium/extensions/date_time'
+require 'opium/extensions/date'
+require 'opium/extensions/time'
+require 'opium/extensions/regexp'
+require 'opium/extensions/pointer'

data/lib/opium/model/attributable.rb

@@ -0,0 +1,37 @@
+module Opium
+  module Model
+    module Attributable
+      extend ActiveSupport::Concern
+      
+      included do
+        include ActiveModel::ForbiddenAttributesProtection
+      end
+      
+      def attributes
+        @attributes ||= self.class.default_attributes
+      end
+      
+      def attributes=(values)
+        sanitize_for_mass_assignment( rubyize_field_names( values ) ).each do |k, v|
+          field_info = self.class.fields[k]
+          if field_info.present?
+            send( "#{k}=", v )
+          else
+            attributes[k] = v
+          end
+        end
+      end
+      
+      def attributes_to_parse( options = {} )
+        options[:except] ||= self.class.fields.values.select {|f| f.readonly? }.map {|f| f.name} if options[:not_readonly]
+        Hash[*self.as_json( options ).map {|k, v| [self.class.fields[k].name_to_parse, v.to_parse]}.flatten]
+      end
+      
+      private
+      
+      def rubyize_field_names( hash )
+        Hash[*hash.map {|k, v| [self.class.ruby_canonical_field_names[k] || k, v]}.flatten]
+      end
+    end
+  end
+end