shopify_theme 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09f5dc9eab1ad2d39124fc370b4e84047adf062a
-  data.tar.gz: 1119a4e02bff799bf80a7d91462b5c34bc68d1d6
+  metadata.gz: 6157b9bdb277a5335fb30d287296a7d190678f6d
+  data.tar.gz: 4d67641a71dbf5f44a3b96296fa749761fcedefa
 SHA512:
-  metadata.gz: 52d308c07b4d8c061c6971457eabb519fcaa87c205fefd27b2360d2fc3bcf5b4e1669ca981e897b3d493e4d149f2ac907896b6c37f98fb408d4387e02af88e69
-  data.tar.gz: 6fd1f422f49cc2ab4a129c1d5d6fc33eae3d6743a036ba02453e900bafd1e4f6de196cb3fcf9650d59d8f97094ebd540b5b83e43c2cbf2a447b7532d68518387
+  metadata.gz: 88bae8b6b99275741f476858dedcadab0bb2216a791c1f7715dee1e1ad4dfb4992a07bee500ababbaecc21004a5abc89a1cdf7a0690f1dd634c33176d8eb6bce
+  data.tar.gz: 357a5dd0f6875e1ba8d77f756022bdbcb6865158dca36a513a8991cee735bd84fc59ae7e1ccedfbe1f4b68274d665cee3e046dbe05570eb46adbd9f09a057590

data/README.md

@@ -43,6 +43,9 @@ Example of config.yml. Notice store has no http or https declaration. You can
 use `:whitelist_files:` to specify files for upload. The `assets/`, `config/`,
 `layout/`, `snippets/` and `templates/` directories are included by default.
 
+You can also use `:ignore_files:` to exclude files from getting uploaded, for
+example your `config/settings.html` or other configuration driven items
+
 ```yaml
 ---
 :api_key: 7a8da86d3dd730b67a357dedabaac5d6
@@ -52,6 +55,8 @@ use `:whitelist_files:` to specify files for upload. The `assets/`, `config/`,
 :whitelist_files:
 - directoryToUpload/
 - importantFile.txt
+:ignore_files:
+- config/settings.html
 ```
 
 Download all the theme files
@@ -90,6 +95,16 @@ Open the store in the default browser
 theme open
 ```
 
+Bootstrap a new theme with [Timber](http://www.shopify.com/timber)
+
+```
+# use latest stable
+theme bootstrap api_key password shop_name theme_name
+
+# use latest build
+theme bootstrap api_key password shop_name theme_name master
+```
+
 # Common Problems
 
 ## How do I edit a theme that isn't my shops main theme?

data/lib/shopify_theme.rb

@@ -7,6 +7,8 @@ module ShopifyTheme
   NOOPParser = Proc.new {|data, format| {} }
   TIMER_RESET = 10
   PERMIT_LOWER_LIMIT = 3
+  TIMBER_ZIP = "https://github.com/Shopify/Timber/archive/%s.zip"
+  LAST_KNOWN_STABLE = "v1.1.0"
 
   def self.test?
     ENV['test']
@@ -79,10 +81,24 @@ module ShopifyTheme
     response
   end
 
+  def self.upload_timber(name, master)
+    source = TIMBER_ZIP % (master ? 'master' : LAST_KNOWN_STABLE)
+    puts master ? "Using latest build from shopify" : "Using last known stable build -- #{LAST_KNOWN_STABLE}"
+    response = shopify.post("/admin/themes.json", :body => {:theme => {:name => name, :src => source, :role => 'unpublished'}})
+    manage_timer(response)
+    body = JSON.parse(response.body)
+    if theme = body['theme']
+      watch_until_processing_complete(theme)
+    else
+      puts "Could not download theme!"
+      puts body
+      exit 1
+    end
+  end
+
   def self.config
     @config ||= if File.exist? 'config.yml'
       config = YAML.load(File.read('config.yml'))
-      puts ":ignore_files: is deprecated for a white list, use :whitelist_files: instead" if config[:ignore_files] && !test?
       config
     else
       puts "config.yml does not exist!" unless test?
@@ -90,16 +106,20 @@ module ShopifyTheme
     end
   end
 
+  def self.config=(config)
+    @config = config
+  end
+
   def self.path
     @path ||= config[:theme_id] ? "/admin/themes/#{config[:theme_id]}/assets.json" : "/admin/assets.json"
   end
 
   def self.ignore_files
-    @ignore_files ||= (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
+    (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
   end
 
   def self.whitelist_files
-    @whitelist_files ||= (config[:whitelist_files] || []).compact
+    (config[:whitelist_files] || []).compact
   end
 
   def self.is_binary_data?(string)
@@ -120,4 +140,15 @@ module ShopifyTheme
     base_uri "https://#{config[:store]}"
     ShopifyTheme
   end
+
+  def self.watch_until_processing_complete(theme)
+    count = 0
+    while true do
+      Kernel.sleep(count)
+      response = shopify.get("/admin/themes/#{theme['id']}.json")
+      theme = JSON.parse(response.body)['theme']
+      return theme if theme['previewable']
+      count += 5
+    end
+  end
 end

data/lib/shopify_theme/cli.rb

@@ -36,6 +36,27 @@ module ShopifyTheme
       create_file('config.yml', config.to_yaml)
     end
 
+    desc "bootstrap API_KEY PASSWORD STORE THEME_NAME", "bootstrap with Timber to shop and configure local directory. Include master if you'd like to use the latest build for the theme"
+    method_option :master, :type => :boolean, :default => false
+    def bootstrap(api_key=nil, password=nil, store=nil, theme_name=nil, master=nil)
+      ShopifyTheme.config = {:api_key => api_key, :password => password, :store => store}
+
+      theme_name ||= 'Timber'
+      say("Registering #{theme_name} theme on #{store}", :green)
+      theme = ShopifyTheme.upload_timber(theme_name, master || false)
+      
+      say("Creating directory named #{theme_name}", :green)
+      empty_directory(theme_name)
+      
+      say("Saving configuration to #{theme_name}", :green)
+      ShopifyTheme.config.merge!(theme_id: theme['id'])
+      create_file("#{theme_name}/config.yml", ShopifyTheme.config.to_yaml)
+      
+      say("Downloading #{theme_name} assets from Shopify")
+      Dir.chdir(theme_name)
+      download()
+    end
+
     desc "download FILE", "download the shops current theme assets"
     method_option :quiet, :type => :boolean, :default => false
     method_option :exclude
@@ -151,7 +172,7 @@ module ShopifyTheme
     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 }
+        @permitted_files.none? { |regex| regex =~ p } || ShopifyTheme.ignore_files.any? { |regex| regex =~ p }
       end
     end
 

data/lib/shopify_theme/version.rb

@@ -1,3 +1,3 @@
 module ShopifyTheme
-  VERSION = "0.0.16"
+  VERSION = "0.0.17"
 end

data/shopify_theme.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'minitest', '>= 5.0.0'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-debugger'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/spec_helper.rb

@@ -1 +1,3 @@
 require 'minitest/autorun'
+require 'pry'
+require 'pry-debugger'

data/spec/unit/cli_spec.rb

@@ -26,12 +26,22 @@ module ShopifyTheme
 
     before do
       @cli = CliDouble.new
+      ShopifyTheme.config = {}
     end
 
     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']
-      assert_equal 2, @cli.send(:local_assets_list).length
-      assert_equal false, @cli.send(:local_assets_list).include?('config.yml')
+      local_assets_list = @cli.send(:local_assets_list)
+      assert_equal 2, local_assets_list.length
+      assert_equal false, local_assets_list.include?('config.yml')
+    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')
     end
 
     it "should generate the shop path URL to the query parameter preview_theme_id if the id is present" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - John Duff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -108,6 +108,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  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: Command line tool to help with developing Shopify themes. Provides simple
   commands to download, upload and delete files from a theme. Also includes the watch
   command to watch a directory and upload files as they change.