business_catalyst 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebd523e90badcb23d6f42231fff79aa330fc1aba
-  data.tar.gz: 338d09a05a59a264e99f3fef3cd99a5172e4b394
+  metadata.gz: 9272b0607f422d8c6918c3b2c6e029caf84e16cc
+  data.tar.gz: 541a6512cd442b3ef87cc10485afe830ff361a11
 SHA512:
-  metadata.gz: 49ae8e6de8384791115ec8ed422880f1cbef57fe32e5ee83dd673f2615fd8c42d52a4de9c4656e3ceb71e8f43c285e1658e9eab1e68ec36abb482f59d08e8261
-  data.tar.gz: 13f7cf5e67f510372cb4e6b02a3efa4b54f0f2bb33b28ae0002f33f8f2b7dd2bc29293c465b7675731431c9633b6ab10b3b81ae6614ac4c596ce9707ac19a13d
+  metadata.gz: 9e1d2c13d6c44435d0f5c134bb3ee26b9732364f701b3d27b2d6eb3bc8b1c56890e56de612bd5d52d9b234294c805e16f745dd6c2a34aa9b810facf2f316c2cb
+  data.tar.gz: e1be3f0029f8d95c30558b50eb5e2e3dc93685ed7a0393ba05f59d96d3634ac5b668ac086990a287684facb5bfa60fd328232a11c7cd91e1cd36c0a57d98aac6

data/.travis.yml

@@ -3,9 +3,8 @@ script:
   - "bundle exec rspec spec"
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
   - 1.8.7
+  - 2.3.5
+  - 2.4.2
   - jruby-18mode # JRuby in 1.8 mode
-  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-head # Latest JRuby

data/README.md

@@ -1,7 +1,11 @@
 # BusinessCatalyst
 
+![CI Status](https://travis-ci.org/tortus/business_catalyst.svg?branch=master)
+
 Tools for building CSV's for Adobe Business Catalyst e-commerce platform in Ruby. Use a Ruby DSL to turn your data into CSV's that can be imported in the BC admin. Supports product and catalog CSV's, and splitting large CSV's (over 10k products) into multiple files.
 
+**Compatible with Ruby 1.8.7 and Ruby 2.3+.** Intended to be useful as a tool for migrating very old Rails sites, so we deliberately preserve Ruby 1.8 compatibility, even when it is a huge pain. Otherwise, we only maintain compatibility with the latest version because most sites that can run on 1.9 can be upgraded to 2.3 with **much** less effort.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,8 +26,9 @@ Start with subclassing any of the provided Row classes:
 Then define methods to return values for the various BC columns.
 Use the #map method to ensure correct naming. (In general, it is just the
 underscored version of the BC column name, with '?' appended for
-boolean columns. The COLUMNS constant in the base class has the complete
-list, and I recommend referring to it extensively.)
+boolean columns. __Refer to COLUMNS constant in the base class, or
+https://github.com/tortus/business_catalyst/wiki for a complete list
+of columns.__)
 
 ### Building a Product CSV
 
@@ -54,6 +59,8 @@ products.each do |product|
 end
 ```
 
+__Refer to https://github.com/tortus/business_catalyst/wiki for the complete list of columns.__
+
 ### Returning Ruby data types in your methods
 
 In general, you can define your methods to return Ruby types such as Array,
@@ -75,7 +82,7 @@ map(:enabled?) { true } # becomes: "Y"
 ### If you have more than 10k product rows to import, use BusinessCatalyst::CSV::FileSplitter
 
 Business Catalyst limits the number of products you can import in a single
-CSV to 10000. However, you can get around this limit by importing multiple
+CSV to 10,000. However, you can get around this limit by importing multiple
 files. We have a class to help!
 
 ```ruby
@@ -90,15 +97,73 @@ end
 ```
 See the class definition for all available options.
 
+### Product Attributes
+
+This gem has full support for multiple product attributes with multiple options.
+In your attributes column definition, create and return one or more instances
+of BusinessCatalyst::CSV::ProductAttribute.
+
+```ruby
+class MyRow < BusinessCatalyst::CSV::ProductRow
+  map :attributes do
+    # Shorthand usage with no price differences or images
+    size =  BusinessCatalyst::CSV::ProductAttribute.new("Size",
+              :display_as => :dropdown,
+              :required => true,
+              :keep_stock => false
+            )
+    size.add_options("Small", "Medium", "Large")
+
+    # Radio buttons with images and different prices for each option
+    color = BusinessCatalyst::CSV::ProductAttribute.new("Color",
+              :display_as => :radio,
+              :required => true,
+              :keep_stock => false
+            )
+    color.add_option("Red", "live/url/for/red.jpg", "US/25.0")
+    color.add_option("Green", "live/url/for/green.jpg", "US/22.0")
+    color.add_option("Blue", "live/url/for/blue.jpg", "US/26.0")
+
+    # Checkbox example without images
+    addon = BusinessCatalyst::CSV::ProductAttribute.new("Addon",
+              :display_as => :checkbox,
+              :required => false,
+              :keep_stock => false
+            )
+    addon.add_option("Some cool bling", nil, "US/5.00")
+
+    [size, color, addon]
+  end
+end
+
+```
+
+### Notes on Currency
+
+You can always return prices as Ruby Numeric types, or a raw String in
+the format that BC understands "US/10.00".
+
+* If you ureturn a Ruby Numeric type, the "default currency" will be used.
+* If you return a String, it will pass through "as-is".
+* You can also return an array of Strings or numbers. These will be converted to the correct string format and joined with ";" allowing you to specify multiple prices.
+
+```ruby
+BusinessCatalyst::CSV::CurrencyTransformer.default_currency = "US"
+
+map(:sell_price) { 10 }
+# => "US/10.00"
+
+map(:sell_price) { ["US/10", "EU/12"] }
+# => "US/10.00;EU/12.00"
+
+```
+
+
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Run tests:
-
-    $ bundle install
-    $ bundle exec rspec spec
-
+3. Run tests: ```bundle exec rspec spec```
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request

data/Rakefile

@@ -1 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end

data/business_catalyst.gemspec

@@ -6,7 +6,7 @@ require 'business_catalyst/version'
 Gem::Specification.new do |spec|
   spec.name          = "business_catalyst"
   spec.version       = BusinessCatalyst::VERSION
-  spec.authors       = ["Tortus Tek, Inc."]
+  spec.authors       = ["William Makley"]
   spec.email         = ["support@tortus.com"]
   spec.description   = %q{Tools for creating CSV's for the Adobe Business Catalyst e-commerce platform in Ruby. Use a Ruby DSL to turn your data into CSV's that can be imported in the BC admin. Supports product and catalog CSV's, and splitting large CSV's (over 10k products) into multiple files.}
   spec.summary       = "business_catalyst-#{BusinessCatalyst::VERSION}"
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "rake", "< 11.0"
   spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rdoc"
 end

data/lib/business_catalyst/csv/catalog_row.rb

@@ -2,6 +2,7 @@ module BusinessCatalyst
   module CSV
     class CatalogRow < Row
 
+      # [Header, method, default, transformer]
       COLUMNS = [
         ["Catalog Name/Heirarchy", :catalog_name_hierarchy, nil, CatalogTransformer],
         ["Description", :description],

data/lib/business_catalyst/csv/product_attribute.rb

@@ -1,13 +1,44 @@
 # encoding: utf-8
+
 module BusinessCatalyst
   module CSV
-
+    # Usage:
+    #
+    #     # Dropdowns with custom image and price:
+    #     size =  BusinessCatalyst::CSV::ProductAttribute.new("Size",
+    #               :display_as => :radio,
+    #               :required => true,
+    #               :keep_stock => false
+    #             )
+    #     size.add_option("Small", "live/url/for/small.jpg", "US/20.00")
+    #     size.add_option("Large", "live/url/for/large.jpg", "US/25.00")
+    #
+    #     # Shorthand for multiple radio buttons with no image or price:
+    #     color = BusinessCatalyst::CSV::ProductAttribute.new("Size",
+    #               :display_as => :radio,
+    #               :required => true,
+    #               :keep_stock => false
+    #             )
+    #     color.add_options("Red", "Green", "Blue")
+    #
+    #     # Checkboxes are supported as well:
+    #     addon = BusinessCatalyst::CSV::ProductAttribute.new("Addon",
+    #               :display_as => :checkbox,
+    #               :required => false,
+    #               :keep_stock => false
+    #             )
+    #     addon.add_option("Cool thing 1", nil, "US/5.00")
+    #
     class ProductAttribute
       Option = Struct.new(:name, :image, :price)
 
-      attr_accessor :name, :required, :keep_stock
-      attr_reader :display_as
+      attr_accessor :name, :required, :keep_stock, :display_as
 
+      # Available options:
+      #
+      # * :display_as => :dropdown / :checkbox / :radio
+      # * :required => true / false
+      # * :keep_stock => true / false
       def initialize(name, options = {})
         @name = name
         self.display_as = options.delete(:display_as) { nil }

data/lib/business_catalyst/version.rb

@@ -1,3 +1,3 @@
 module BusinessCatalyst
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: business_catalyst
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- Tortus Tek, Inc.
+- William Makley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tools for creating CSV's for the Adobe Business Catalyst e-commerce platform
   in Ruby. Use a Ruby DSL to turn your data into CSV's that can be imported in the
   BC admin. Supports product and catalog CSV's, and splitting large CSV's (over 10k
@@ -122,10 +136,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: business_catalyst-0.1.1
+summary: business_catalyst-0.1.2
 test_files:
 - spec/lib/business_catalyst/business_catalyst_spec.rb
 - spec/lib/business_catalyst/csv/catalog_row_spec.rb