shopify_theme 0.0.14 → 0.0.15

data/README.md

@@ -1,26 +1,32 @@
+# Edit your Shopify theme locally
+
+The Shopify theme gem is a command line tool that lets you make live changes to your published theme.
+
+It will watch your local folders for any changes in your theme (including adding and removing files) and will update your .myshopify.com store to the latest changes. 
+
 # Requirements
 
 Ruby 1.9
 
 # Installation
 
-````
+```
 gem install shopify_theme [optional_theme_id]
-````
+```
 
 # Usage
 
-Generate the config file. Go get a valid api_key and password for your store head to https://[your store].myshopify.com/admin/apps/private and generate a private application. Default it adds the main theme, if you want to edit one of your other themes, add the theme_id.
+Generate the config file. Go get a valid api_key and password for your store head to `https://[your store].myshopify.com/admin/apps/private` and generate a private application. Default it adds the main theme, if you want to edit one of your other themes, add the `theme_id`.
 
-````
+```
 theme configure api_key password store_url
-````
+```
 
 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.
 
-````
+```yaml
 ---
 :api_key: 7a8da86d3dd730b67a357dedabaac5d6
 :password: 552338ce0d3aba7fc501dcf99bc57a81
@@ -29,43 +35,43 @@ use `:whitelist_files:` to specify files for upload. The `assets/`, `config/`,
 :whitelist_files:
 - directoryToUpload/
 - importantFile.txt
-````
+```
 
 Download all the theme files
 
-````
+```
 theme download
-````
+```
 
 Upload a theme file
 
-````
+```
 theme upload assets/layout.liquid
-````
+```
 
 Remove a theme file
 
-````
+```
 theme remove assets/layout.liquid
-````
+```
 
 Completely replace shop theme assets with the local assets
 
-````
+```
 theme replace
-````
+```
 
 Watch the theme directory and upload any files as they change
 
-````
+```
 theme watch
-````
+```
 
 Open the store in the default browser
 
-````
+```
 theme open
-````
+```
 
 # Common Problems
 

data/lib/shopify_theme.rb

@@ -1,6 +1,8 @@
 require 'httparty'
 module ShopifyTheme
   include HTTParty
+  @@current_api_call_count = 0
+  @@total_api_calls = 40
 
   NOOPParser = Proc.new {|data, format| {} }
   TIMER_RESET = 5 * 60 + 5

data/lib/shopify_theme/cli.rb

@@ -5,7 +5,7 @@ require 'abbrev'
 require 'base64'
 require 'fileutils'
 require 'json'
-require 'listen'
+require 'filewatcher'
 require 'launchy'
 
 module ShopifyTheme
@@ -50,9 +50,7 @@ module ShopifyTheme
 
     desc "open", "open the store in your browser"
     def open(*keys)
-      config = YAML.load_file 'config.yml'
-      url = config[:store]
-      if Launchy.open url
+      if Launchy.open shop_theme_url
         say("Done.", :green)
       end
     end
@@ -100,30 +98,51 @@ module ShopifyTheme
     method_option :keep_files, :type => :boolean, :default => false
     def watch
       puts "Watching current folder: #{Dir.pwd}"
-      listener = Listen.to(Dir.pwd) do |modified, added, removed|
-        modified.each do |filePath|
-          filePath.slice!(Dir.pwd + "/")
-          send_asset(filePath, options['quiet']) if local_assets_list.include?(filePath)
-        end
-        added.each do |filePath|
-          filePath.slice!(Dir.pwd + "/")
-          send_asset(filePath, options['quiet']) if local_assets_list.include?(filePath)
-        end
-        unless options['keep_files']
-          removed.each do |filePath|
-            filePath.slice!(Dir.pwd + "/")
-            delete_asset(filePath, options['quiet']) if !local_assets_list.include?(filePath)
+      watcher do |filename, event|
+        filename = filename.gsub("#{Dir.pwd}/", '')
+        if local_assets_list.include?(filename)
+          action = case event
+          when :changed, :new then :send_asset
+          when :delete then :delete_asset
+          else raise NotImplementedError, "Unknown event -- #{event}"
           end
+          send(action, filename, options['quiet'])
         end
       end
-      listener.start
-      sleep
-    rescue Interrupt
-      puts "exiting...."
+    end
+
+    desc "systeminfo", "print out system information and actively loaded libraries for aiding in submitting bug reports"
+    def systeminfo
+      ruby_version = "#{RUBY_VERSION}"
+      ruby_version += "-p#{RUBY_PATCHLEVEL}" if RUBY_PATCHLEVEL
+      puts "Ruby: v#{ruby_version}"
+      puts "Operating System: #{RUBY_PLATFORM}"
+      %w(Thor Listen HTTParty Launchy).each do |lib|
+        require "#{lib.downcase}/version"
+        puts "#{lib}: v" +  Kernel.const_get("#{lib}::VERSION")
+      end
+    end
+
+    protected
+
+    def config
+      @config ||= YAML.load_file 'config.yml'
+    end
+
+    def shop_theme_url
+      url = config[:store]
+      url += "?preview_theme_id=#{config[:theme_id]}" if config[:theme_id] && config[:theme_id].to_i > 0
+      url
     end
 
     private
 
+    def watcher
+      FileWatcher.new(Dir.pwd).watch() do |filename, event|
+        yield(filename, event)
+      end
+    end
+
     def local_assets_list
       local_files.reject do |p|
         @permitted_files ||= (DEFAULT_WHITELIST | ShopifyTheme.whitelist_files).map{|pattern| Regexp.new(pattern)}

data/lib/shopify_theme/version.rb

@@ -1,3 +1,3 @@
 module ShopifyTheme
-  VERSION = "0.0.14"
+  VERSION = "0.0.15"
 end

data/shopify_theme.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency("thor", [">= 0.14.4"])
   s.add_dependency("httparty", "~> 0.10.0")
   s.add_dependency("json", "~> 1.5.4")
-  s.add_dependency("listen", "~>2.0")
+  s.add_dependency("filewatcher")
   s.add_dependency("launchy")
 
   s.add_development_dependency 'rake'

data/spec/unit/cli_spec.rb

@@ -6,7 +6,17 @@ module ShopifyTheme
   describe "Cli" do
 
     class CliDouble < Cli
-      attr_writer :local_files
+      attr_writer :local_files, :mock_config
+
+      desc "",""
+      def config
+        @mock_config || super
+      end
+
+      desc "",""
+      def shop_theme_url
+        super
+      end
 
       desc "", ""
       def local_files
@@ -23,5 +33,18 @@ module ShopifyTheme
       assert_equal 2, @cli.send(:local_assets_list).length
       assert_equal false, @cli.send(:local_assets_list).include?('config.yml')
     end
+
+    it "should generate the shop path URL to the query parameter preview_theme_id if the id is present" do
+      @cli.mock_config = {store: 'somethingfancy.myshopify.com', theme_id: 12345}
+      assert_equal "somethingfancy.myshopify.com?preview_theme_id=12345", @cli.shop_theme_url
+    end
+
+    it "should generate the shop path URL withouth the preview_theme_id if the id is not present" do
+      @cli.mock_config = {store: 'somethingfancy.myshopify.com'}
+      assert_equal "somethingfancy.myshopify.com", @cli.shop_theme_url
+
+      @cli.mock_config = {store: 'somethingfancy.myshopify.com', theme_id: ''}
+      assert_equal "somethingfancy.myshopify.com", @cli.shop_theme_url
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_theme
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-26 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -60,21 +60,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.4
 - !ruby/object:Gem::Dependency
-  name: listen
+  name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -344329295272915207
+      hash: -577831141083631280
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -344329295272915207
+      hash: -577831141083631280
 requirements: []
 rubyforge_project: shopify_theme
 rubygems_version: 1.8.23