potpourri 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 967a37b13ab8e26fda50157cb6fc92d1665e7dcd
-  data.tar.gz: 0bf7c3a2c6a2a1603a171b86044ec4da19b8fd06
+  metadata.gz: d64b0b2d194f014dd59f79a25684560647b78428
+  data.tar.gz: 44d3bdcd7a9305589eeec0277bd6115a28248724
 SHA512:
-  metadata.gz: 7f1449404d6a6f59bc162151835488c06a8900fcc81d8753b46cb70719a38ba374243376e4649516684b62a253c3e24fec92abab5237d10a83a2380fe3415d44
-  data.tar.gz: 167ea8d0944bf69d4d5b4a4775639e284ebee459195df3854b6c65bde3edd2b58d2359693ac8b05f97b9398d77b34e9acee7bdf5b9e4be537dfe79ab39f10527
+  metadata.gz: 3005829d8de99b8c900fc59f16a23a57a7e8627d7cc9fb789ed2c9ac12f0032bcf5265f6fecb80a0546df90568257b8f06c504b346456b336a158bfca94e14fb
+  data.tar.gz: 761b16e880c02dcaae94204b9078036e62507332da8deae8e82d1b211390f73a0a18769838a3b2cfbc84bd5befc7f1e82c12c56b774e6b2749314cea69a1ea35

data/README.md

@@ -34,9 +34,9 @@ class StarshipReport < Potpourri::Report
   resource_class Starship
 
   fields [
-    Potpourri::Field(:captain),
-    Potpourri::ExportableField(:registration_number),
-    Potpourri::ImportableField(:shield_frequency)
+    field(:captain),
+    export_field(:registration_number),
+    import_field(:shield_frequency)
   ]
 end
 ```
@@ -63,9 +63,9 @@ report.import # => An array of Starship objects
 Fields can be customized in a number of ways. It is easy to decide what fields will be imported and which are
 exported. Extra fields in an import will simply be ignored, so all generated exports are able to be imported.
 
-- Potpourri::Field           => These fields will be both imported and exported
-- Potpourri::ExportableField => These fields will only be exported
-- Potpourri::ImportableField => These fields will only be imported
+- field        => These fields will be both imported and exported
+- export_field => These fields will only be exported
+- import_field => These fields will only be imported
 
 Fields will interpolate which methods are used to get and set values on a model. They will also use a
 variation of the Rails `#titleize` method to generate a header for the csv.
@@ -75,15 +75,8 @@ variation of the Rails `#titleize` method to generate a header for the csv.
 These assumptions can be easily overriden by passing some options into the Field when the report is defined.
 
 ```ruby
-  fields [
-    Potpourri::Field(:registration_number),
-    Potpourri::Field(:captain),
-    Potpourri::ImportableField(:shield_frequency)
-  ]
-...
-
 fields [
-    Potpourri::Field(
+    field(
       :captain,
       export_method: :command_officer,
       import_method: :fearless_leader=,
@@ -91,19 +84,20 @@ fields [
     )
 ]
 
-...
-
 ```
 The importable and exportable fields also respond to the same methods, however of course they will only be either importable or exportable.
 
 ### ActiveRecord Extension
 
 Importing and exporting dynamic models is only so useful. Enter the ActiveRecord extension. It provides a
-`Potpourri::ActiveRecord::Report` class. This class is a subclass of `Potpourri::Report` so it responds in
-much the same way, with some bells and whistles.
+`Potpourri::ActiveRecordExtention` module. This module includes a new field to indicate which column references
+the unique identifier for the object, and controls the logic for creating and updating records during an
+import.
 
 ```ruby
-class StarshipReport < Potpourri::ActiveRecord::Report
+class StarshipReport < Potpourri::Report
+  include Potpourri::ActiveRecordExtension
+
   resource_class Starship
 
   fields [

data/lib/extensions/active_record/active_record_extension.rb

@@ -3,6 +3,7 @@ module Potpourri
     def self.included(mod)
       raise NotAReport unless mod.ancestors.include?(Report)
       mod.extend ClassMethods
+      mod.include ActiveRecord::FieldHelpers
     end
 
     class MissingIdentifierField < StandardError; end
@@ -16,7 +17,6 @@ module Potpourri
       self.class.instance_variable_get '@can_create_new_records'
     end
 
-
     def identifier_field
       fields.detect &:identifier?
     end

data/lib/extensions/active_record/field_helpers.rb

@@ -0,0 +1,15 @@
+module Potpourri
+  module ActiveRecord
+    module FieldHelpers
+      def self.included(mod)
+        mod.extend ClassMethods
+      end
+
+      module ClassMethods
+        def id_field(name, options = {})
+          IdentifierField.new name, options
+        end
+      end
+    end
+  end
+end

data/lib/extensions/active_record/indentifier_field.rb

@@ -1,10 +1,6 @@
 module Potpourri
   module ActiveRecord
-    class IdentifierField < Field
-      def importable?
-        false
-      end
-
+    class IdentifierField < ExportableField
       def identifier?
         true
       end

data/lib/lib/field_helpers.rb

@@ -0,0 +1,21 @@
+module Potpourri
+  module FieldHelpers
+    def self.included(mod)
+      mod.extend ClassMethods
+    end
+
+    module ClassMethods
+      def field(name, options = {})
+        Field.new name, options
+      end
+
+      def importable_field(name, options = {})
+        ImportableField.new name, options
+      end
+
+      def exportable_field(name, options = {})
+        ExportableField.new name, options
+      end
+    end
+  end
+end

data/lib/models/exportable_field.rb

@@ -1,3 +1,5 @@
+require 'models/field'
+
 module Potpourri
   class ExportableField < Field
     def importable?

data/lib/models/report.rb

@@ -3,6 +3,7 @@ require 'csv'
 module Potpourri
   class Report
     include ReportConfigs
+    include FieldHelpers
 
     attr_reader :path
 

data/lib/potpourri/version.rb

@@ -1,3 +1,3 @@
 module Potpourri
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: potpourri
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - brendandeere
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -138,7 +138,9 @@ files:
 - bin/console
 - bin/setup
 - lib/extensions/active_record/active_record_extension.rb
+- lib/extensions/active_record/field_helpers.rb
 - lib/extensions/active_record/indentifier_field.rb
+- lib/lib/field_helpers.rb
 - lib/lib/report_configs.rb
 - lib/lib/titleize.rb
 - lib/models/exportable_field.rb