shopify_theme 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6971fe42d85d617b5d0a95de3c9e34279dac2199
-  data.tar.gz: d3ca43ec6f1b2ed28266e67a6036d748709a0f85
+  metadata.gz: 50c5d2b43b94c79a4bc37a4d3b71080f2d9e85fb
+  data.tar.gz: bcc2ec0776ca9e537601a94df1146c5ada57a23a
 SHA512:
-  metadata.gz: 994ba6ea158f91729a131200ebc778c72467234febfa8716e72f829156c75fd028e6d9c085ba80bc6fa0bd7e9a5d6c11a7778db69d1bd42c06e37134abfb87e2
-  data.tar.gz: 94ee9d1a1266d99e6b9a0f762e8bfe0e8cfa50bf09f2651a58d070e5de1c42e73020bfdadcfd3d45e1e51b8cbcb0ee54e2e83a9863dc8f1ad0f5a844c6e72592
+  metadata.gz: 75463c446905bc9d79d59e1b2e3fead8706624c605321f3582dbcdd61713d6b5fc4d8a9cf96d284323bc2f1b3339489fda0cfb7ba79557e9479e59a50c9af21d
+  data.tar.gz: 66c63f7bd44755b65773e8a3684dd49e9c951dbb8ac25b13d5ffcea63c1c7d0739188e3118a5b7c2705f67a5c6def6d2cceeceb64117233b2fca7c95341378d7

data/lib/shopify_theme.rb

@@ -7,6 +7,8 @@ module ShopifyTheme
   NOOPParser = Proc.new {|data, format| {} }
   TIMER_RESET = 10
   PERMIT_LOWER_LIMIT = 3
+  MAX_TIMBER_RETRY = 5
+
 
   def self.test?
     ENV['test']
@@ -79,7 +81,7 @@ module ShopifyTheme
     response
   end
 
-  def self.upload_timber(name, version)
+  def self.upload_timber(name, version, retries=0)
     release = Releases.new.find(version)
     response = shopify.post("/admin/themes.json", :body => {:theme => {:name => name, :src => release.zip_url, :role => 'unpublished'}})
     manage_timer(response)
@@ -87,6 +89,8 @@ module ShopifyTheme
     if theme = body['theme']
       puts "Successfully created #{name} using Shopify Timber #{version}"
       watch_until_processing_complete(theme)
+    elsif retries < MAX_TIMBER_RETRY
+      upload_timber(name, version, retries + 1)
     else
       puts "Could not download theme!"
       puts body
@@ -113,7 +117,7 @@ module ShopifyTheme
   end
 
   def self.ignore_files
-    (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
+    (config[:ignore_files] || []).compact
   end
 
   def self.whitelist_files

data/lib/shopify_theme/cli.rb

@@ -8,6 +8,7 @@ require 'json'
 require 'filewatcher'
 require 'launchy'
 require 'mimemagic'
+require 'shopify_theme/file_filters'
 
 module ShopifyTheme
   EXTENSIONS = [
@@ -57,7 +58,7 @@ module ShopifyTheme
 
     desc "configure API_KEY PASSWORD STORE THEME_ID", "generate a config file for the store to connect to"
     def configure(api_key=nil, password=nil, store=nil, theme_id=nil)
-      config = {:api_key => api_key, :password => password, :store => store, :theme_id => theme_id}
+      config = {:api_key => api_key, :password => password, :store => store, :theme_id => theme_id, :whitelist_files => Filters::Whitelist::DEFAULT_WHITELIST}
       create_file('config.yml', config.to_yaml)
       check(true)
     end
@@ -72,7 +73,7 @@ module ShopifyTheme
     method_option :master, :type => :boolean, :default => false
     method_option :version, :type => :string, :default => "latest"
     def bootstrap(api_key=nil, password=nil, store=nil, theme_name=nil)
-      ShopifyTheme.config = {:api_key => api_key, :password => password, :store => store}
+      ShopifyTheme.config = {:api_key => api_key, :password => password, :store => store, :whitelist_files => Filters::Whitelist::DEFAULT_WHITELIST}
       check(true)
 
       theme_name ||= 'Timber'
@@ -98,7 +99,7 @@ module ShopifyTheme
     method_option :exclude
     def download(*keys)
       check(true)
-      assets = keys.empty? ? ShopifyTheme.asset_list : keys
+      assets = assets_for(keys, ShopifyTheme.asset_list)
 
       if options['exclude']
         assets = assets.delete_if { |asset| asset =~ Regexp.new(options['exclude']) }
@@ -122,6 +123,7 @@ module ShopifyTheme
     method_option :quiet, :type => :boolean, :default => false
     def upload(*keys)
       check(true)
+      assets = assets_for(keys, local_assets_list)
       assets = keys.empty? ? local_assets_list : keys
       assets.each do |asset|
         send_asset(asset, options['quiet'])
@@ -192,6 +194,13 @@ module ShopifyTheme
       end
     end
 
+    def local_assets_list
+      FileFilters.new(
+        Filters::Whitelist.new(ShopifyTheme.whitelist_files),
+        Filters::Blacklist.new(ShopifyTheme.ignore_files)
+      ).select(local_files)
+    end
+
     protected
 
     def config
@@ -205,6 +214,10 @@ module ShopifyTheme
     end
 
     private
+    def assets_for(keys=[], files=[])
+      filter = FileFilters.new(Filters::CommandInput.new(keys))
+      filter.select(files)
+    end
 
     def watcher
       FileWatcher.new(Dir.pwd).watch() do |filename, event|
@@ -212,13 +225,6 @@ module ShopifyTheme
       end
     end
 
-    def local_assets_list
-      local_files.reject do |p|
-        @permitted_files ||= (DEFAULT_WHITELIST | ShopifyTheme.whitelist_files).map{|pattern| Regexp.new(pattern)}
-        @permitted_files.none? { |regex| regex =~ p } || ShopifyTheme.ignore_files.any? { |regex| regex =~ p }
-      end
-    end
-
     def local_files
       Dir.glob(File.join('**', '*')).reject do |f|
         File.directory?(f)

data/lib/shopify_theme/file_filters.rb

@@ -0,0 +1,18 @@
+require 'shopify_theme/filters/blacklist'
+require 'shopify_theme/filters/whitelist'
+require 'shopify_theme/filters/command_input'
+
+module ShopifyTheme
+  class FileFilters
+    def initialize(*filters)
+      raise ArgumentError, "Must have at least one filter to apply" unless filters.length > 0
+      @filters = filters
+    end
+
+    def select(list)
+      @filters.reduce(list) do |results, filter|
+        filter.select(results)
+      end
+    end
+  end
+end

data/lib/shopify_theme/filters/blacklist.rb

@@ -0,0 +1,17 @@
+module ShopifyTheme
+  module Filters
+    class Blacklist
+      attr_reader :patterns
+
+      def initialize(pattern_strings=[])
+        @patterns = pattern_strings.map { |p| Regexp.new(p)}
+      end
+
+      def select(list)
+        list.select do |entry|
+          patterns.none? { |pat| pat.match(entry) }
+        end
+      end
+    end
+  end
+end

data/lib/shopify_theme/filters/command_input.rb

@@ -0,0 +1,17 @@
+module ShopifyTheme
+  module Filters
+    class CommandInput
+      attr_reader :patterns
+      def initialize(inputs=[])
+        @patterns = inputs.map { |i| Regexp.compile(i) }
+      end
+
+      def select(list)
+        return list if patterns.empty?
+        list.select { |entry|
+          patterns.any? { |pat| pat.match(entry) }
+        }
+      end
+    end
+  end
+end

data/lib/shopify_theme/filters/whitelist.rb

@@ -0,0 +1,19 @@
+module ShopifyTheme
+  module Filters
+    class Whitelist
+      DEFAULT_WHITELIST = %w(layout/ assets/ config/ snippets/ templates/ locales/)
+
+      attr_reader :patterns
+
+      def initialize(pattern_strings=[])
+        @patterns = (pattern_strings.empty? ? DEFAULT_WHITELIST : pattern_strings).map { |pattern| Regexp.new(pattern) }
+      end
+
+      def select(list)
+        list.select do |entry|
+          patterns.any? { |pat| pat.match(entry) }
+        end
+      end
+    end
+  end
+end

data/lib/shopify_theme/version.rb

@@ -1,3 +1,3 @@
 module ShopifyTheme
-  VERSION = "0.0.23"
+  VERSION = "0.0.24"
 end

data/spec/unit/cli_spec.rb

@@ -36,17 +36,22 @@ module ShopifyTheme
 
     it "should remove assets that are not a part of the white list" do
       @cli.local_files = ['assets/image.png', 'config.yml', 'layout/theme.liquid', 'locales/en.default.json']
-      local_assets_list = @cli.send(:local_assets_list)
-      assert_equal 3, local_assets_list.length
-      assert_equal false, local_assets_list.include?('config.yml')
+      assert_equal 3, @cli.local_assets_list.length
+      assert_equal false, @cli.local_assets_list.include?('config.yml')
+    end
+
+    it 'should only use the whitelist entries for determining which files to upload (bug #156)' do
+      @cli.local_files = %w(assets/application.css.liquid assets/application.js assets/image.png assets/bunny.jpg layout/index.liquid snippets/preview.liquid)
+      ShopifyTheme.config = {whitelist_files: %w(assets/application.css.liquid assets/application.js layout/ snippets/)}
+      assert_equal 4, @cli.local_assets_list.length
+      assert_equal false, @cli.local_assets_list.include?('assets/image.png')
     end
 
     it "should remove assets that are part of the ignore list" do
       ShopifyTheme.config = {ignore_files: ['config/settings.html']}
       @cli.local_files = ['assets/image.png', 'layout/theme.liquid', 'config/settings.html']
-      local_assets_list = @cli.send(:local_assets_list)
-      assert_equal 2, local_assets_list.length
-      assert_equal false, local_assets_list.include?('config/settings.html')
+      assert_equal 2, @cli.local_assets_list.length
+      assert_equal false, @cli.local_assets_list.include?('config/settings.html')
     end
 
     it "should generate the shop path URL to the query parameter preview_theme_id if the id is present" do

data/spec/unit/file_filters_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'shopify_theme/file_filters'
+
+module ShopifyTheme
+  describe "FileFilters" do
+    class IdentityFilter
+      def select(list)
+        list.select { true }
+      end
+    end
+
+    class EvenFilter
+      def select(list)
+        list.select { |i| i % 2 == 0 }
+      end
+    end
+
+    it "initializing without a filter raises an error" do
+      assert_raises ArgumentError do
+        FileFilters.new
+      end
+    end
+
+    it "initializing with a single filter" do
+      begin
+        FileFilters.new(IdentityFilter.new)
+      rescue Error => e
+        flunk("Initializing with a single filter should not fail. #{e}")
+      end
+    end
+
+    it "should only select entries that were valid for all of the given filters" do
+      filters = FileFilters.new(IdentityFilter.new, EvenFilter.new)
+      assert_equal [2, 4], filters.select([1, 2, 3, 4, 5])
+    end
+  end
+end

data/spec/unit/filters/blacklist_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'shopify_theme/filters/blacklist'
+
+
+module ShopifyTheme
+  module Filters
+    describe "Blacklist" do
+      TEST_PATHS = %w(
+          settings.html
+          config/item1.html
+          config/item2.html
+          config/item3.html
+          layout/thing1.html
+          assets/application.css.liquid
+          assets/application.js
+          templates/thing2.html
+          snippets/fancy.liquid
+      )
+
+      it "should return the entire list back if initialized with no patterns" do
+        blacklist = Blacklist.new
+        assert_equal TEST_PATHS, blacklist.select(TEST_PATHS)
+      end
+
+      it "should return everything except for the items that matched the pattern" do
+        blacklist = Blacklist.new(%w(config/* settings.html assets/* templates/* snippets/*))
+        assert_equal %w(layout/thing1.html), blacklist.select(TEST_PATHS)
+      end
+
+    end
+  end
+end

data/spec/unit/filters/command_input_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'shopify_theme/filters/command_input'
+
+module ShopifyTheme
+  module Filters
+    describe "CommandInput" do
+      it "should return the entire list if initialized with nothing" do
+        filter = CommandInput.new([])
+        assert_equal %w(a b c d e f), filter.select(%w(a b c d e f))
+      end
+
+      it "should return a subset if initialized with some values" do
+        filter = CommandInput.new(%w(a c d))
+        assert_equal %w(a c d a), filter.select(%w(a b c d e a f))
+      end
+    end
+  end
+end

data/spec/unit/filters/whitelist_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'shopify_theme/filters/whitelist'
+
+module ShopifyTheme
+  module Filters
+    describe "Whitelist" do
+      TEST_PATHS = %w(
+          settings.html
+          config/item1.html
+          config/item2.html
+          config/item3.html
+          layout/thing1.html
+          assets/application.css.liquid
+          assets/application.js
+          templates/thing2.html
+          snippets/fancy.liquid
+      )
+
+      it "should use the default whitelist if nothing was provided" do
+        whitelist = Whitelist.new
+        expected = %w(
+          config/item1.html
+          config/item2.html
+          config/item3.html
+          layout/thing1.html
+          assets/application.css.liquid
+          assets/application.js
+          templates/thing2.html
+          snippets/fancy.liquid
+        )
+        assert_equal expected, whitelist.select(TEST_PATHS)
+      end
+
+      it "should ignore the default 1+ whitelists were provided" do
+        whitelist = Whitelist.new %w(settings.html config/item1.html config/item2.html config/item3.html layout/ templates/)
+        expected = %w(settings.html config/item1.html config/item2.html config/item3.html layout/thing1.html templates/thing2.html)
+        assert_equal expected, whitelist.select(TEST_PATHS)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors:
 - John Duff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -174,6 +174,10 @@ files:
 - lib/shopify_theme.rb
 - lib/shopify_theme/api_checker.rb
 - lib/shopify_theme/cli.rb
+- lib/shopify_theme/file_filters.rb
+- lib/shopify_theme/filters/blacklist.rb
+- lib/shopify_theme/filters/command_input.rb
+- lib/shopify_theme/filters/whitelist.rb
 - lib/shopify_theme/releases.rb
 - lib/shopify_theme/version.rb
 - shipit.rubygems.yml
@@ -185,6 +189,10 @@ files:
 - spec/spec_helper.rb
 - spec/unit/api_checker_spec.rb
 - spec/unit/cli_spec.rb
+- spec/unit/file_filters_spec.rb
+- spec/unit/filters/blacklist_spec.rb
+- spec/unit/filters/command_input_spec.rb
+- spec/unit/filters/whitelist_spec.rb
 - spec/unit/releases_spec.rb
 homepage: https://github.com/Shopify/shopify_theme
 licenses: