restforce-db 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5c876e8802d8d0c563d8229ea3ebcfaa79347ce
-  data.tar.gz: c74173bd30c5d1994091bf2ab832ad214403c9ed
+  metadata.gz: 2a376fa3d3ec57765c0d869be30dbd381e637559
+  data.tar.gz: 686f7970d90cb52377daeefab21f6e0b91c2d03c
 SHA512:
-  metadata.gz: 54721e2987733bd681aeda548e188438c0905771870820b38fa115a7c490dbfd8ee5d63691448384951649a2df23b34410bb877c4d14d013d6247c54d5c956b7
-  data.tar.gz: d7949e0760680a8433b5f9c6019a75c09e5862bc0013062403e2ae7d12ff70017aeed8eb8b1e585bd8c5bff507778000f30efa2e3e5a8a3ad4298c945f5f8674
+  metadata.gz: f377bfbcc127e815625f81908d2ab4ac509c6bce489552808dfcf11af3236ec8abdd299661c58fec0fe84ec0fcb3824678fe41ee51aaed274522fc03147b10ef
+  data.tar.gz: aeafbb041eef87730d18558bb897e5606cf54b4f8dbb379bcb4b08e7d3a789a703a3da99c9c22669588c6d78f59624344b0d88236c3629c02b0c5f1dadd6a0f8

data/README.md

@@ -22,23 +22,32 @@ Or install it yourself as:
 
 First, you'll want to install the default bin and configuration files, which is handled by the included Rails generator:
 
-    $ bundle exec rails g restforce
+    $ bundle exec rails g restforce:install
 
 This gem assumes that you're running Rails 4 or greater, therefore the `bin` file should be checked into the repository with the rest of your code. The `config/restforce-db.yml` file should be managed the same way you manage your secrets files, and probably not checked into the repository.
 
+### Update your model schema
+
+In order to keep your database records in sync with Salesforce, the table will need to store a reference to its associated Salesforce record. A generator is included to trivially add this `salesforce_id` column to your tables:
+
+    $ bundle exec rails g restforce:migration MyModel
+    $ bundle exec rake db:migrate
+
+### Register a mapping
+
 To register a Salesforce mapping in an `ActiveRecord` model, you need to add a few lines of DSL-style code to your class definition:
 
 ```ruby
-class LineCook < ActiveRecord::Base
+class MyModel < ActiveRecord::Base
 
   include Restforce::DB::Model
 
-  map_to "Line_Cook__c", name: "Name", specialty: "Favorite_Food__c"
+  map_to "Object__c", name: "Name", color: "Color__c"
 
 end
 ```
 
-This will automatically register the model with an entry in the `Restforce::DB::RecordType` collection. Your schema **must** contain a `salesforce_id` column for each table you wish to synchronize with a record type in Salesforce. 
+This will automatically register the model with an entry in the `Restforce::DB::RecordType` collection.
 
 To run the worker, you'll want to run the binstub installed through the generator (see above). Then you can run the self-daemonizing executable.
 

data/lib/generators/restforce/install_generator.rb

@@ -0,0 +1,23 @@
+require "rails/generators/base"
+
+module Restforce
+
+  # :nodoc:
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path("../../templates", __FILE__)
+
+    # :nodoc:
+    def create_config_file
+      template "config.yml", "config/restforce-db.yml"
+    end
+
+    # :nodoc:
+    def create_executable_file
+      template "script", "bin/restforce-db"
+      chmod "bin/restforce-db", 0755
+    end
+
+  end
+
+end

data/lib/generators/restforce/migration_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators/active_record"
+
+module Restforce
+
+  # :nodoc:
+  class MigrationGenerator < ActiveRecord::Generators::Base
+
+    source_root File.expand_path("../../templates", __FILE__)
+
+    # :nodoc:
+    def create_migration_file
+      migration_template "migration.rb", "db/migrate/add_#{singular_name}_salesforce_binding.rb"
+    end
+
+  end
+
+end

data/lib/generators/templates/migration.rb.tt

@@ -0,0 +1,10 @@
+# :nodoc:
+class Add<%= class_name %>SalesforceBinding < ActiveRecord::Migration
+
+  # :nodoc:
+  def change
+    add_column :<%= table_name %>, :salesforce_id, :string
+    add_index :<%= table_name %>, :salesforce_id, unique: true
+  end
+
+end

data/lib/restforce/db/version.rb

@@ -3,7 +3,7 @@ module Restforce
   # :nodoc:
   module DB
 
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Andrew Horner
@@ -214,8 +214,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/generators/restforce_generator.rb
+- lib/generators/restforce/install_generator.rb
+- lib/generators/restforce/migration_generator.rb
 - lib/generators/templates/config.yml
+- lib/generators/templates/migration.rb.tt
 - lib/generators/templates/script
 - lib/restforce/db.rb
 - lib/restforce/db/command.rb

data/lib/generators/restforce_generator.rb

@@ -1,19 +0,0 @@
-require "rails/generators/base"
-
-# :nodoc:
-class RestforceGenerator < Rails::Generators::Base
-
-  source_root File.expand_path("../templates", __FILE__)
-
-  # :nodoc:
-  def create_config_file
-    template "config.yml", "config/restforce-db.yml"
-  end
-
-  # :nodoc:
-  def create_executable_file
-    template "script", "bin/restforce-db"
-    chmod "bin/restforce-db", 0755
-  end
-
-end