infopark-crm-helpers 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f67a52709806c3af34201d8521a7f4ffb380f8f0
-  data.tar.gz: 080c86daf942030ffda72ff30836cff775ea350c
+  metadata.gz: eea6fceef4486786190a225cbc9bed5eb085df59
+  data.tar.gz: fe8160fcbd9a2a8c363e3775448125c4c5066bb3
 SHA512:
-  metadata.gz: 6a4181f5800b1e9efed341d41671fb3be5bb3d934deaba0a6e8cfee25c432d139bbbe4d72f322604d14665aa9f16cc3810454887d01dd7a782bd3315f4e36026
-  data.tar.gz: 94fd635728f590b81f1471508304729ddfdf6d29d97de0309b449471d2e5cfec731c0b10c4d6382c66de2fce4b8a698073e9e9fb3da79dceefd9878ef9a9306e
+  metadata.gz: e25ab420786e572ddd640aee45f2c829a60feb4bbed053690f1fe8877eb320203bec1d428657203551242cdedaf8e3bc3a2020e1920aa495b7165f11de4b74a2
+  data.tar.gz: 3fcbe7e7877fd07be90bfce405351d90d59d6005b5a2003fc7fd6caee8c9e418512f9a3e50eb46df4fe73a21e501efb560111d2b6b1fffe3ddca5cbb47bbcf3c

data/README.md

@@ -188,3 +188,59 @@ You can use those to explicitly validate attributes for a certain format.
 validates_with Crm::Helpers::Validators::CrmBooleanValidator,
                attributes: [:custom_has_ps4, :custom_has_xbox_one]
 ```
+
+## Finders
+
+```ruby
+class Customer
+  include ActiveModel::Validations
+  include Crm::Helpers::Attributes
+  include Crm::Helpers::Finders
+
+  represents_crm_type :contact
+
+  crm_attr_accessor :first_name, :last_name, :email
+  validates_with Crm::Helpers::Validators::CrmTypeValidator
+
+  def initialize(attributes = {})
+    @crm_attributes = attributes.dup
+  end
+end
+
+customer = Customer.find('fc851ba935f8420824498aee739ac897')
+# => #<Customer>
+```
+
+## Persistence
+
+```ruby
+class Customer
+  include ActiveModel::Validations
+  include Crm::Helpers::Attributes
+  include Crm::Helpers::Persistence
+
+  represents_crm_type :contact
+
+  crm_attr_accessor :first_name, :last_name, :email
+  validates_with Crm::Helpers::Validators::CrmTypeValidator
+
+  def initialize(attributes = {})
+    @crm_attributes = attributes.dup
+  end
+end
+
+customer = Customer.create(language: 'en', last_name: 'Dinh')
+# => #<Customer>
+
+customer.language = 'de'
+# => 'de'
+
+customer.save
+# => true
+
+customer.update(language: 'en')
+# => true
+
+customer.destroy
+# => #<Customer>
+```

data/changelog.md

@@ -1,3 +1,9 @@
+### 1.1.0
+
+- Add `assign_attributes` to `Crm::Helpers::Attributes`.
+- Add `Crm::Helpers::Finders`, which provides `.find` and `find_by_query`.
+- Add `Crm::Helpers::Persistence`, which provides `.create`, `#save`, `#save!`, `#update`, `#update!`, and `#destroy`.
+
 ### 1.0.2
 
 - Fix an issue wherein some `crm_attr_reader` were not created correctly.

data/lib/crm/helpers/attributes.rb

@@ -8,12 +8,23 @@ module Crm
       module ClassMethods
         attr_reader :crm_type
 
-        def represents_crm_type(type)
-          @crm_type = type
+        def represents_crm_type(crm_type)
+          @crm_type = crm_type
+          @crm_class = nil
           @crm_attributes = {}.with_indifferent_access
+
           crm_attr_accessor(*mandatory_crm_attributes)
         end
 
+        def crm_class
+          return nil if @crm_type.blank?
+          return @crm_class if @crm_class.present?
+
+          type_definition = crm_type_definition(crm_type)
+          class_name = "Crm::#{type_definition.item_base_type}"
+          @crm_class = class_name.constantize
+        end
+
         def mandatory_crm_attributes
           crm_attributes.select { |_, definition| definition[:mandatory] }.keys.sort.map(&:to_sym)
         end
@@ -70,7 +81,7 @@ module Crm
         protected
 
         def collect_crm_attributes_data(crm_type)
-          type = Crm::Type.find(crm_type)
+          type = crm_type_definition(crm_type)
           @crm_attributes = type.standard_attribute_definitions
           # This is a lovely hack, because the language attribute does not get
           # the correct valid values in #standard_attribute_definitions. Maybe
@@ -78,6 +89,14 @@ module Crm
           @crm_attributes[:language][:valid_values] += type.languages if @crm_attributes[:language].present?
           @crm_attributes.merge!(type.attribute_definitions)
         end
+
+        def crm_type_definition(crm_type)
+          Crm::Type.find(crm_type)
+        end
+      end
+
+      def assign_attributes(new_attributes)
+        @crm_attributes = crm_attributes.merge(new_attributes)
       end
 
       def crm_attributes

data/lib/crm/helpers/finders.rb

@@ -0,0 +1,25 @@
+module Crm
+  module Helpers
+    module Finders
+      def self.included(base)
+        base.extend self
+      end
+
+      def find(id)
+        crm_object = crm_class.find(id)
+        return nil if crm_object.blank?
+
+        new(crm_object.attributes)
+      end
+
+      def find_by_query(query, options = {})
+        limit = options[:limit] || 50
+        sort_order = options[:sort_order] || 'desc'
+
+        crm_class.query(query).limit(limit).sort_order(sort_order).to_a.map do |crm_object|
+          new(crm_object.attributes)
+        end
+      end
+    end
+  end
+end

data/lib/crm/helpers/persistence.rb

@@ -0,0 +1,67 @@
+module Crm
+  module Helpers
+    module Persistence
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def create(attributes = {})
+          instance = new(attributes)
+          return instance if instance.invalid?
+
+          instance.save!
+          instance
+        end
+      end
+
+      def save
+        update
+      end
+
+      def save!
+        update!
+      end
+
+      def update(attributes = {})
+        assign_attributes(attributes)
+        return false if invalid?
+
+        persist
+      end
+
+      def update!(attributes = {})
+        assign_attributes(attributes)
+        raise "#{self.class.name} object is invalid." if invalid?
+
+        persist
+      end
+
+      def destroy
+        crm_object.destroy
+        self
+      end
+
+      def persist
+        return false if invalid?
+
+        @crm_object = if crm_object.nil?
+                        self.class.crm_class.create(crm_attributes)
+                      else
+                        crm_object.update(crm_attributes)
+                      end
+        assign_attributes(crm_object.attributes)
+        true
+      end
+
+      protected
+
+      def crm_object
+        return @crm_object if defined?(@crm_object)
+        return nil if id.blank?
+
+        @crm_object = self.class.crm_class.find(id)
+      end
+    end
+  end
+end

data/lib/crm/helpers/version.rb

@@ -1,5 +1,5 @@
 module Crm
   module Helpers
-    VERSION = '1.0.2'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/lib/crm/helpers.rb

@@ -16,6 +16,8 @@ require 'crm/helpers/validators/crm_text_validator'
 require 'crm/helpers/validators/crm_type_validator'
 
 require 'crm/helpers/attributes'
+require 'crm/helpers/finders'
+require 'crm/helpers/persistence'
 require 'crm/helpers/version'
 
 require 'crm/helper'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: infopark-crm-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Huy Dinh
@@ -146,6 +146,8 @@ files:
 - lib/crm/helper.rb
 - lib/crm/helpers.rb
 - lib/crm/helpers/attributes.rb
+- lib/crm/helpers/finders.rb
+- lib/crm/helpers/persistence.rb
 - lib/crm/helpers/validators/crm_boolean_validator.rb
 - lib/crm/helpers/validators/crm_datetime_validator.rb
 - lib/crm/helpers/validators/crm_each_validator.rb