dropkiq 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67f91deee2e77eadf3639d16853d4c5c4e3fbff7
-  data.tar.gz: b506e1be0dcaeeecbc0bef0b01bd228a9658116a
+  metadata.gz: 870702ba0f303232074a4f4c1d217615845c66f5
+  data.tar.gz: 167038a34aa51b3b1f0ee9071c0609f852c922f2
 SHA512:
-  metadata.gz: c0b21a001f69663a377d163df25d0fa3ba26c868675348127b6e1f7228263137dedb95cbd48c0819b59647d489fa31e688855a12143c1cde734fcd5ba11c6c36
-  data.tar.gz: ce674e523319eaaa6c1f2ea8e435e693f9edb2ebbf359943e816be9b66c9e959e375ad4702c22dd01fb558dad868a68838cb0c29a95bfb0936699111a4194511
+  metadata.gz: 69f78f513c67744275c65ed9128be60c3eb0fb6a07e0650c621dd94f656ba22d55a174f724f0a75e3c38394dec3200b5ca72a3fd3e44a2757091afbbd9a3a5b2
+  data.tar.gz: 02b69534482e6b999e57da7fbea7c7a9cf550b213d179fd44dab2275dee5b5085bc3d5bc8b216fbabb61536fe719ceeb6bfeabf115f8ed8a85b125fe59c27448

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropkiq (0.1.0)
+    dropkiq (0.1.1)
       activerecord (>= 4.2)
       liquid (~> 4.0)
 
@@ -27,6 +27,7 @@ GEM
     liquid (4.0.3)
     method_source (0.9.2)
     minitest (5.13.0)
+    mocha (1.11.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -43,6 +44,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   dropkiq!
   minitest (~> 5.0)
+  mocha (~> 1.11.2)
   pry (~> 0.12.2)
   rake (~> 10.0)
   sqlite3 (~> 1.3.13)

data/README.md

@@ -36,14 +36,92 @@ This Gem makes several assumptions about your Ruby on Rails application:
 
 This Gem provides a rake command to generate a schema file that can be used to manage Fixtures on Dropkiq. Create the `db/dropkiq_schema.yaml` file by running the following command:
 
+
 ```
 bundle exec rake dropkiq:schema
 ```
 
+
 You should now have a `db/dropkiq_schema.yaml` file. This file describes all tables associated to Drop classes in your application, along with all methods avaialble to the Drop class. It is important that you **DO** allow this file to be checked in to version control so that you can maintain your Dropkiq schema over time as you add/remove/modify your Drop classes.
 
 Notice that `type` has NOT been set on all methods. The Dropkiq Gem is only able to infer the method type for methods that correspond to a column or relationship on the ActiveRecord model. Please take a moment to manually add `type` values for all methods that were not able to be inferred. Notice that if you run `bundle exec rake dropkiq:schema` again, your changes are saved!
 
+
+#### Ruby on Rails Column to Dropkiq Data Type Mappings
+
+| Ruby on Rails Column Type | Dropkiq Data Type |
+| --- | --- |
+| `string` | `ColumnTypes::String` |
+| `integer` | `ColumnTypes::Numeric` |
+| `boolean` | `ColumnTypes::Boolean` |
+| `datetime` | `ColumnTypes::DateTime` |
+| `date` | `ColumnTypes::DateTime` |
+| `decimal` | `ColumnTypes::Numeric` |
+| `float` | `ColumnTypes::Numeric` |
+| `text` | `ColumnTypes::Text` |
+| `time` | `ColumnTypes::DateTime` |
+| `binary` | `ColumnTypes::Numeric` |
+
+#### Ruby on Rails Associations to Dropkiq Data Type Mappings
+
+| Ruby on Rails Association Type | Dropkiq Data Type |
+| --- | --- |
+| `belongs_to` | `ColumnTypes::HasOne` |
+| `has_one` | `ColumnTypes::HasOne` |
+| `has_many` | `ColumnTypes::HasMany` |
+| `has_one through:` | `ColumnTypes::HasOne` |
+| `has_many through:` | `ColumnTypes::HasMany` |
+| `has_and_belongs_to_many` | `ColumnTypes::HasMany` |
+
+**Please note:** You must also specify a `foreign_table_name` for any Association column in Dropkiq. These types can also be used for arbitrary methods within your Drop class that simply returns a single instance or array of instances of a Drop Class.
+
+```ruby
+class PersonDrop < Liquid::Drop
+  # ...
+end
+
+class GroupDrop < Liquid::Drop
+  def initialize(group)
+    @group = group
+  end
+
+  # Use the ColumnTypes::HasOne column type and specify the foreign_table_name as "people"
+  def owner
+    owner_membership  = @group.memberships.find_by!(owner: true)
+    PersonDrop.new(owner_membership.person)
+  end
+
+  # Use the ColumnTypes::HasMany column type and specify the foreign_table_name as "people"
+  def managers
+    @group.memberships.where(manager: true).map{|m| PersonDrop.new(m.person)}
+  end
+end
+```
+
+
+Dropkiq also provides a `ColumnTypes::YAML` Column Type if your Drop class model has any methods that simply return an Array or Hash, such as this example:
+
+```ruby
+class ProductDrop < Liquid::Drop
+  def initialize(product)
+    @product = product
+  end
+
+  # Use the ColumnTypes::YAML column type and serialize the Array as Yaml
+  def possible_sku_numbers
+    [12345, 67890, 45678, 12390]
+  end
+
+  # Use the ColumnTypes::YAML column type and serialize the Hash as Yaml
+  def custom_data
+    {
+      description: "This is a book about bananas",
+      price: 12.95
+    }
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/dropkiq.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "sqlite3", "~> 1.3.13"
+  spec.add_development_dependency "mocha", "~> 1.11.2"
 
   spec.add_dependency "activerecord", ">= 4.2"
   spec.add_dependency "liquid", "~> 4.0"

data/lib/dropkiq/drop_class_analyzer.rb

@@ -9,6 +9,11 @@ module Dropkiq
 
     def analyze
       self.active_record_class = find_active_record_class
+
+      if active_record_class.blank?
+        raise "No ActiveRecord Class found for #{liquid_drop_class.name}"
+      end
+
       self.table_name = active_record_class.table_name
       self.drop_method_params = find_drop_method_params
     end

data/lib/dropkiq/version.rb

@@ -1,3 +1,3 @@
 module Dropkiq
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dropkiq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Darrah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.13
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement