active_force 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fc8bc2425de35aa52c303eb28a9165a2601c5f5
-  data.tar.gz: b397002aa1906d23b92d4d20ff08745d349c6cb4
+  metadata.gz: 36f3376b1b60bba8f226a7b811550b16fc4fccf2
+  data.tar.gz: 8c5f72016eb4139055f141858d7377d6dc93a84c
 SHA512:
-  metadata.gz: ef355901a29bd4ff95bf593400f3a52e32e53cd4bec886b5d057984a31092f832b0ce0cf4608462f6379652ad91120d4437100177d4f3912e0051a85abbfa9fb
-  data.tar.gz: 8ce4758557b84eef8662c8f53ff3e301ecdc077d1f824ef2850cb17636d6dde5cab9ed564ca57d3b02ed9a600a188b6e133ebb6eefa8f536803d3a767abcf672
+  metadata.gz: 7ec85db056728c1365e39f2934726daa912d67b6fae0865dcfbe1b88313c991dac416a24ba0c6bf516955125cc2471550ca38d427485d894078d477e0bf05c4a
+  data.tar.gz: 1b9263f3bdaab14b9ce0abe6c366684032dbeb7d01f5a1718003f5d7b0c640163722849ec69eebff1e2f57f48a1c9fda9ffc36a145ec87938b5e5173476a0457

data/.travis.yml

@@ -1,10 +1,17 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.0.0
   - 2.1.1
+  - rbx-2
 matrix:
   allow_failures:
-    - rvm: rbx-2
+    - rvm:
+      - rbx-2
   fast_finish: true
 env:
-  - CODECLIMATE_REPO_TOKEN=1c5ed259429e0bfc5412974d69cfba2780962a87ca8c543d684e33fea37f7e71 
+  - CODECLIMATE_REPO_TOKEN=1c5ed259429e0bfc5412974d69cfba2780962a87ca8c543d684e33fea37f7e71
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/a790a8fc07d033f05e00

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Not released
 
+* Add select statement functionality. ([Pablo Oldani][], [#33][])
+* Add callback functionality ([Pablo Oldani][], [#20][])
+* Support bind parameters. ([Dan Olson][], [#29][])
+* Fix when passing nil value in a :where condition. ([Armando Andini][])
+* Model generator complete ([Armando Andini][], [#19][])
+
 ## 0.5.0
 
 * Provide a default id field for all SObject subclassees ([Dan Olson][], [#30][])

data/README.md

@@ -3,7 +3,7 @@
 [![Code Climate](http://img.shields.io/codeclimate/github/ionia-corporation/active_force.svg)](https://codeclimate.com/github/ionia-corporation/active_force)
 [![Dependency Status](http://img.shields.io/gemnasium/ionia-corporation/active_force.svg)](https://gemnasium.com/ionia-corporation/active_force)
 [![Test Coverage](https://codeclimate.com/github/ionia-corporation/active_force/badges/coverage.svg)](https://codeclimate.com/github/ionia-corporation/active_force)
-
+[![Chat](http://img.shields.io/badge/chat-gitter-brightgreen.svg)](https://gitter.im/ionia-corporation/active_force)
 
 # ActiveForce
 
@@ -37,38 +37,48 @@ Restforce.log = true if Rails.env.development?
 
 ## Usage
 
-### Define a class
-
 ```ruby
-class Page < ActiveForce::SObject
+class Medication < ActiveForce::SObject
 
-end
-```
+  field :name,             from: 'Name'
 
-### Add Attributes
+  field :max_dossage  # from defaults to "Max_Dossage__c" 
+  field :updated_from
 
-```ruby
-class Page < ActiveForce::SObject
-  #field, :attribute_name, from: 'Name_In_Salesforce_Database'
-  field :id,                from: 'Id'
-  field :name,              from: 'Medication__c'
-  #set SalesForce table name.
-  self.table_name = 'Patient_Medication__c'
-end
-```
+  ##
+  # Table name is infered from class name.
+  #
+  # self.table_name = 'Medication__c' # default one.
 
-### Validations
+  ##
+  # Validations
+  #
+  validates :name, :login, :email, presence: true
 
-You can use any validation that active record has (except for validates_associated), just by adding them to your class:
+  # Use any validation from active record.
+  # validates :text, length: { minimum: 2 }
+  # validates :text, format: { with: /\A[a-zA-Z]+\z/, message: "only allows letters" }
+  # validates :size, inclusion: { in: %w(small medium large),
+  #   message: "%{value} is not a valid size" }
 
-```ruby
-validates :name, :login, :email, presence: true
-validates :text, length: { minimum: 2 }
-validates :text, format: { with: /\A[a-zA-Z]+\z/, message: "only allows letters" }
-validates :size, inclusion: { in: %w(small medium large),
-    message: "%{value} is not a valid size" }
+  ##
+  # Callbacks
+  #
+  before_save :set_as_updated_from_rails
+
+  private
+
+  def set_as_updated_from_rails
+    self.updated_from = 'Rails'
+  end
+
+end
 ```
 
+Altenative you can try the generator. (requires setting up the connection)
+
+    rails generate active_force_model Medication__c
+
 ### Relationships
 
 #### Has Many
@@ -76,38 +86,30 @@ validates :size, inclusion: { in: %w(small medium large),
 ```ruby
 class Account < ActiveForce::SObject
   has_many :pages
-end
-
-class Page < ActiveForce::SObject
-  field :account_id,           from: 'Account__c'
-end
-```
 
-you could send a option parameter in the declaration.
+  # Use option parameters in the declaration.
 
-```ruby
-class Account < ActiveForce::SObject
   has_many :medications,
-    where: "(Date_Discontinued__c > #{ Date.today.strftime("%Y-%m-%d") } or Date_Discontinued__c = NULL)"
+    where: "Discontinued__c > #{ Date.today.strftime("%Y-%m-%d") }" \
+           "OR Discontinued__c = NULL"
 
-  has_many :today_log_entrys,
+  has_many :today_log_entries,
     model: DailyLogEntry,
-    where: "Date__c = #{ Time.now.in_time_zone.strftime("%Y-%m-%d") }"
+    where: { date: Time.now.in_time_zone.strftime("%Y-%m-%d") }
 
   has_many :labs,
-    where: "Category__c = 'EMR' And Date__c <> NULL",
+    where: "Category__c = 'EMR' AND Date__c <> NULL",
     order: 'Date__c DESC'
+
 end
 ```
 
 #### Belongs to
 
 ```ruby
-class Account < ActiveForce::SObject
-end
-
 class Page < ActiveForce::SObject
   field :account_id,           from: 'Account__c'
+
   belongs_to :account
 end
 ```
@@ -118,6 +120,6 @@ end
 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 so we can talk about it.
+5. Create new pull request so we can talk about it.
 6. Once accepted, please add an entry in the CHANGELOG and rebase your changes
    to squash typos or corrections.

data/active_force.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_dependency 'active_attr', '~> 0.8'
   spec.add_dependency 'restforce',   '~> 1.4'

data/lib/active_attr/dirty.rb

@@ -17,10 +17,5 @@ module ActiveAttr
       end
     end
 
-    def initialize(attributes = nil, options = {})
-      super(attributes, options)
-      changed_attributes.clear
-    end
-
   end
 end

data/lib/active_force/active_query.rb

@@ -2,6 +2,7 @@ require 'active_force/query'
 require 'forwardable'
 
 module ActiveForce
+  class PreparedStatementInvalid < ArgumentError; end
   class ActiveQuery < Query
     extend Forwardable
 
@@ -17,7 +18,7 @@ module ActiveForce
     end
 
     def to_a
-      result.to_a.map { |mash| build mash }
+      @records ||= result.to_a.map { |mash| build mash }
     end
 
     alias_method :all, :to_a
@@ -32,23 +33,81 @@ module ActiveForce
       limit == 1 ? to_a.first : self
     end
 
-    def where conditions
-      return super unless conditions.is_a? Hash
-      conditions.each do |key, value|
-        super "#{ mappings[key] } = #{ enclose_value value }"
-      end
+    def where args=nil, *rest
+      return self if args.nil?
+      super build_condition args, rest
       self
     end
 
+    def select *fields
+      fields.map! { |field| mappings[field] }
+      super *fields
+    end
+
     def find_by conditions
       where(conditions).limit 1
     end
 
     private
 
+    def build_condition(args, other=[])
+      case args
+      when String, Array
+        build_condition_from_array other.empty? ? args : ([args] + other)
+      when Hash
+        build_conditions_from_hash args
+      else
+        args
+      end
+    end
+
+    def build_condition_from_array(ary)
+      statement, *bind_parameters = ary
+      return statement if bind_parameters.empty?
+      if bind_parameters.first.is_a? Hash
+        replace_named_bind_parameters statement, bind_parameters.first
+      else
+        replace_bind_parameters statement, bind_parameters
+      end
+    end
+
+    def replace_named_bind_parameters(statement, bind_parameters)
+      statement.gsub(/(:?):([a-zA-Z]\w*)/) do
+        key = $2.to_sym
+        if bind_parameters.has_key? key
+          enclose_value bind_parameters[key]
+        else
+          raise PreparedStatementInvalid, "missing value for :#{key} in #{statement}"
+        end
+      end
+    end
+
+    def replace_bind_parameters(statement, values)
+      raise_if_bind_arity_mismatch statement.count('?'), values.size
+      bound = values.dup
+      statement.gsub('?') do
+        enclose_value bound.shift
+      end
+    end
+
+    def raise_if_bind_arity_mismatch(expected_var_count, actual_var_count)
+      if expected_var_count != actual_var_count
+        raise PreparedStatementInvalid, "wrong number of bind variables (#{actual_var_count} for #{expected_var_count})"
+      end
+    end
+
+    def build_conditions_from_hash(hash)
+      hash.map do |key, value|
+        "#{mappings[key]} = #{enclose_value value}"
+      end
+    end
+
     def enclose_value value
-      if value.is_a? String
+      case value
+      when String
         "'#{value}'"
+      when NilClass
+        'NULL'
       else
         value.to_s
       end

data/lib/active_force/association/association.rb

@@ -25,6 +25,10 @@ module ActiveForce
         define_relation_method
       end
 
+      def infer_foreign_key_from_model(model)
+        name = model.custom_table_name? ? model.name : model.table_name
+        "#{name.downcase}_id".to_sym
+      end
     end
 
   end

data/lib/active_force/association/belongs_to_association.rb

@@ -6,13 +6,21 @@ module ActiveForce
       private
 
       def default_foreign_key
-        "#{ relation_model.name.downcase }_id".to_sym
+        infer_foreign_key_from_model relation_model
       end
 
       def define_relation_method
         association = self
-        @parent.send :define_method, @relation_name do
-          association.relation_model.find(send association.foreign_key)
+        _method = @relation_name
+        @parent.send :define_method, _method do
+          association_cache.fetch(_method) do
+            association_cache[_method] = association.relation_model.find(send association.foreign_key)
+          end
+        end
+
+        @parent.send :define_method, "#{_method}=" do |other|
+          send "#{ association.foreign_key }=", other.id
+          association_cache[_method] = other
         end
       end
     end

data/lib/active_force/association/has_many_association.rb

@@ -5,15 +5,17 @@ module ActiveForce
       private
 
       def default_foreign_key
-        "#{ @parent.name.downcase }_id".to_sym
+        infer_foreign_key_from_model @parent
       end
 
       def define_relation_method
         association = self
         @parent.send :define_method, @relation_name do
-          query = association.relation_model.query
-          query.options association.options
-          query.where association.foreign_key => self.id
+          association_cache.fetch __method__ do
+            query = association.relation_model.query
+            query.options association.options
+            association_cache[__method__] = query.where association.foreign_key => self.id
+          end
         end
       end
     end

data/lib/active_force/query.rb

@@ -30,6 +30,11 @@ module ActiveForce
       SOQL
     end
 
+    def select *columns
+      @query_fields = columns
+      self
+    end
+
     def where condition
       @conditions << condition if condition
       self

data/lib/active_force/sobject.rb

@@ -3,23 +3,26 @@ require 'active_attr'
 require 'active_attr/dirty'
 require 'active_force/active_query'
 require 'active_force/association'
+require 'active_force/table'
 require 'yaml'
 require 'forwardable'
 require 'logger'
 
-
 module ActiveForce
   class SObject
     include ActiveAttr::Model
     include ActiveAttr::Dirty
     include ActiveForce::Association
-    STANDARD_TYPES = %w[ Account Contact Opportunity Campaign]
+    extend ActiveModel::Callbacks
+
+    define_model_callbacks :save, :create, :update
 
     class_attribute :mappings, :table_name
 
     class << self
       extend Forwardable
       def_delegators :query, :where, :first, :last, :all, :find, :find_by, :count
+      def_delegators :table, :custom_table_name?
 
       private
 
@@ -33,10 +36,6 @@ module ActiveForce
         String(attribute).split('_').map(&:capitalize).join('_') << '__c'
       end
 
-      def custom_table_name
-        self.name if STANDARD_TYPES.include? self.name
-      end
-
       ###
       # Provide each subclass with a default id field. Can be overridden
       # in the subclass if needed
@@ -48,7 +47,11 @@ module ActiveForce
     # The table name to used to make queries.
     # It is derived from the class name adding the "__c" when needed.
     def self.table_name
-      @table_name ||= custom_table_name || "#{ self.name.split('::').last }__c"
+      table.name
+    end
+
+    def self.table
+      @table ||= ActiveForce::Table.new name
     end
 
     def self.fields
@@ -72,13 +75,15 @@ module ActiveForce
     def update_attributes! attributes = {}
       assign_attributes attributes
       return false unless valid?
-      sfdc_client.update! table_name, attributes_for_sfdb_update
+      sfdc_client.update! table_name, attributes_for_sfdb
       changed_attributes.clear
       self
     end
 
     def update_attributes attributes = {}
-      update_attributes! attributes
+      run_callbacks :update do
+        update_attributes! attributes
+      end
     rescue Faraday::Error::ClientError => error
       logger_output __method__
     end
@@ -87,13 +92,15 @@ module ActiveForce
 
     def create!
       return false unless valid?
-      self.id = sfdc_client.create! table_name, attributes_for_sfdb_create
+      self.id = sfdc_client.create! table_name, attributes_for_sfdb
       changed_attributes.clear
       self
     end
 
     def create
-      create!
+      run_callbacks :create do
+        create!
+      end
     rescue Faraday::Error::ClientError => error
       logger_output __method__
     end
@@ -107,19 +114,19 @@ module ActiveForce
     end
 
     def save
-      if persisted?
-        update
-      else
-        create
+      run_callbacks :save do
+        if persisted?
+          update
+        else
+          create
+        end
       end
     end
 
     def save!
-      if persisted?
-        update_attributes!
-      else
-        create!
-      end
+      save
+    rescue Faraday::Error::ClientError => error
+      logger_output __method__
     end
 
     def to_param
@@ -141,8 +148,20 @@ module ActiveForce
       @mappings ||= {}
     end
 
+    def reload
+      association_cache.clear
+      reloaded = self.class.find(id)
+      self.attributes = reloaded.attributes
+      changed_attributes.clear
+      self
+    end
+
     private
 
+    def association_cache
+      @association_cache ||= {}
+    end
+
     def logger_output action
       logger = Logger.new(STDOUT)
       logger.info("[SFDC] [#{self.class.model_name}] [#{self.class.table_name}] Error while #{ action }, params: #{hash}, error: #{error.inspect}")
@@ -150,20 +169,13 @@ module ActiveForce
       false
     end
 
-    def attributes_for_sfdb_create
+    def attributes_for_sfdb
       attrs = mappings.map do |attr, sf_field|
-        value = read_attribute(attr)
+        value = read_value(attr)
         [sf_field, value] if value
       end
-      Hash.new(attrs.compact)
-    end
-
-
-    def attributes_for_sfdb_update
-      attrs = changed_mappings.map do |attr, sf_field|
-        [sf_field, read_attribute(attr)]
-      end
-      Hash.new(attrs).merge('Id' => id)
+      attrs << ['Id', id] if persisted?
+      Hash[attrs.compact]
     end
 
     def changed_mappings
@@ -180,7 +192,7 @@ module ActiveForce
     end
 
     def sf_field_type field
-      self.class.attributes[field][:sf_tpye]
+      self.class.attributes[field][:sf_type]
     end
 
     def self.picklist field
@@ -198,4 +210,5 @@ module ActiveForce
       self.class.sfdc_client
     end
   end
+
 end