dev_shopify_theme 0.0.21

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b4bc2a2f214aebb3d716fb73dcbc16c75cece67
+  data.tar.gz: 45aa9e57e59faf45ed4264db7b6fba01ff61a32b
+SHA512:
+  metadata.gz: 3d2abfe0baa1921a294cbf470b5e11f0a4f15f70d3b72be3a9c43a18154e40c6380eb4e12b8b851941ad65b32ddc81cd3cc643482fd732efa0c15a48f5adaa28
+  data.tar.gz: a29ee36ab3d79f27eb4e135bcd7d5897b63044931733ff82c4c9297b672e13f13ead52e88580edfc47eb334455f5fd60dc5992b6abf3b6d354739ad88f5b6eb8

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.project

data/.travis.yml

@@ -0,0 +1,4 @@
+langauge: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# v0.0.21
+
+* Adds Locale support
+* Running `theme replace` no longer deletes unwatched files if they are found on Shopify
+
+# v0.0.20
+
+* Fixes issue with unknown types raising exceptions -- csaunders
+
+# v0.0.19
+
+* Fixes issue with incorrectly detecting binary assets -- csaunders
+* Properly handle unknown event types -- 
+
+# v0.0.12
+
+* Fixes issue where app tried uploading directories
+
+# v0.0.11
+
+* Locks JSON api version which fixed an issue with downloading large binary files -- Tyler Ball
+* Respect API limits when downloading theme assets from Shopify API -- Chris Saunders

data/CONTRIBUTING

@@ -0,0 +1,6 @@
+- If the issue doesn't exist, open one to start a discussion
+- If the issue is fine (it probably is) start working on your patch
+- Create a Pull Request
+  - Be sure to update CHANGELOG.md to include the details of your fix
+- Go through code review
+- Get it merged

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shopify_theme.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Shopify
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# Edit your Shopify theme locally
+
+[![Gem Version](https://badge.fury.io/rb/shopify_theme.svg)](http://badge.fury.io/rb/shopify_theme)
+
+The Shopify theme gem is a command line tool that lets you make live changes to themes on your Shopify store. If the command line is scary, check out the [Desktop Theme Editor app](http://apps.shopify.com/desktop-theme-editor).
+
+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. 
+
+![Shopify theme gem](https://dl.dropboxusercontent.com/u/669627/terminalreadme.png)
+
+You do not need to make changes to your default theme. You can leverage the theme preview feature of Shopify
+that allows you to view what an unpublished theme looks like on your Shopify store. This means you don't need to
+sign up for extra accounts and keep your shop up to date. You will however have a blue bar that shows up that you can
+remove via the web inspector in Chrome or Safari.
+
+# Requirements
+
+This gem works with OS X or Windows with Ruby 1.9. 
+
+First time installing Ruby on windows? Try [Rubyinstaller](http://http://rubyinstaller.org/). 
+
+# Installation
+
+To install the shopify_theme gem use 'gem install' (you might have use 'sudo gem install')
+
+```
+gem install shopify_theme [optional_theme_id]
+```
+
+to update to the latest version
+
+```
+gem update shopify_theme
+```
+
+# 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. By 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/`, `templates/` and `locales/`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
+:password: 552338ce0d3aba7fc501dcf99bc57a81
+:store: little-plastics.myshopify.com
+:theme_id:
+:whitelist_files:
+- directoryToUpload/
+- importantFile.txt
+:ignore_files:
+- config/settings.html
+```
+
+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
+```
+
+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
+
+## SSL Certificates won't verify on Windows
+
+If you are experiencing SSL validation errors, it is most likely because your installation does not have any valid
+certificates. This can be taken care of by [downloading a certificate file](http://curl.haxx.se/ca/cacert.pem) and
+[setting a the SSL_CERT_FILE environment variable on your system](http://www.computerhope.com/issues/ch000549.htm).
+For more details check out the following [gist](https://gist.github.com/fnichol/867550).
+
+[See the following issue for more details](https://github.com/Shopify/shopify_theme/issues/103)
+
+## How do I edit a theme that isn't my shops main theme?
+
+This can be done by setting the `theme_id` field in `config.yml` which was created when you
+ran `theme configure`. Your file should look like the following:
+
+```yaml
+---
+:api_key: 7a8da86d3dd730b67a357dedabaac5d6
+:password: 552338ce0d3aba7fc501dcf99bc57a81
+:store: little-plastics.myshopify.com
+:theme_id: 0987654321
+```
+
+## Where can I find my Theme Id?
+
+Currently the best way to find the id of the theme you want to edit is to go to the theme in your
+shops admin and grab it from the url.
+
+![themes/THEME_ID/settings](doc/how_to_find_theme_id.png)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => [:spec]
+
+Rake::TestTask.new 'spec' do |t|
+  ENV['test'] = 'true'
+  t.libs = ['lib', 'spec']
+  t.ruby_opts << '-rubygems'
+  t.verbose = true
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+

data/bin/dev-theme

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# This allows shopify_theme to run easily from a git checkout without install.
+# Hat tip to chriseppstein of Compass fame for the code for this
+def fallback_load_path(path)
+  retried = false
+  begin
+    yield
+  rescue LoadError
+    unless retried
+      $: << path
+      retried = true
+      retry
+    end
+    raise
+  end
+end
+
+fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
+  require 'shopify_theme'
+  require 'shopify_theme/cli'
+end
+
+ShopifyTheme::Cli.start(ARGV)

data/lib/shopify_theme.rb

@@ -0,0 +1,155 @@
+require 'httparty'
+module ShopifyTheme
+  include HTTParty
+  @@current_api_call_count = 0
+  @@total_api_calls = 40
+
+  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']
+  end
+
+  def self.manage_timer(response)
+    return unless response.headers['x-shopify-shop-api-call-limit']
+    @@current_api_call_count, @@total_api_calls = response.headers['x-shopify-shop-api-call-limit'].split('/')
+    @@current_timer = Time.now if @current_timer.nil?
+  end
+
+  def self.critical_permits?
+    @@total_api_calls.to_i - @@current_api_call_count.to_i < PERMIT_LOWER_LIMIT
+  end
+
+  def self.passed_api_refresh?
+    delta_seconds > TIMER_RESET
+  end
+
+  def self.delta_seconds
+    Time.now.to_i - @@current_timer.to_i
+  end
+
+  def self.needs_sleep?
+    critical_permits? && !passed_api_refresh?
+  end
+
+  def self.sleep
+    if needs_sleep?
+      Kernel.sleep(TIMER_RESET - delta_seconds)
+      @current_timer = nil
+    end
+  end
+
+  def self.api_usage
+    "[API Limit: #{@@current_api_call_count || "??"}/#{@@total_api_calls || "??"}]"
+  end
+
+
+  def self.asset_list
+    # HTTParty parser chokes on assest listing, have it noop
+    # and then use a rel JSON parser.
+    response = shopify.get(path, :parser => NOOPParser)
+    manage_timer(response)
+    assets = JSON.parse(response.body)["assets"].collect {|a| a['key'] }
+    # Remove any .css files if a .css.liquid file exists
+    assets.reject{|a| assets.include?("#{a}.liquid") }
+  end
+
+  def self.get_asset(asset)
+    response = shopify.get(path, :query =>{:asset => {:key => asset}}, :parser => NOOPParser)
+    manage_timer(response)
+
+    # HTTParty json parsing is broken?
+    asset = response.code == 200 ? JSON.parse(response.body)["asset"] : {}
+    asset['response'] = response
+    asset
+  end
+
+  def self.send_asset(data)
+    response = shopify.put(path, :body =>{:asset => data})
+    manage_timer(response)
+    response
+  end
+
+  def self.delete_asset(asset)
+    response = shopify.delete(path, :body =>{:asset => {:key => asset}})
+    manage_timer(response)
+    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'))
+      config
+    else
+      puts "config.yml does not exist!" unless test?
+      {}
+    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
+    (config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
+  end
+
+  def self.whitelist_files
+    (config[:whitelist_files] || []).compact
+  end
+
+  def self.is_binary_data?(string)
+    if string.respond_to?(:encoding)
+      string.encoding == "US-ASCII"
+    else
+      ( string.count( "^ -~", "^\r\n" ).fdiv(string.size) > 0.3 || string.index( "\x00" ) ) unless string.empty?
+    end
+  end
+
+  def self.check_config
+    shopify.get(path).code == 200
+  end
+
+  private
+  def self.shopify
+    basic_auth config[:api_key], config[:password]
+    # TODO: switch back to https
+    # base_uri "https://#{config[:store]}"
+    base_uri "http://#{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

@@ -0,0 +1,304 @@
+require 'thor'
+require 'yaml'
+YAML::ENGINE.yamler = 'syck' if defined? Syck
+require 'abbrev'
+require 'base64'
+require 'fileutils'
+require 'json'
+require 'filewatcher'
+require 'launchy'
+require 'mimemagic'
+
+module ShopifyTheme
+  EXTENSIONS = [
+    {mimetype: 'application/x-liquid', extensions: %w(liquid), parents: 'text/plain'},
+    {mimetype: 'application/json', extensions: %w(json), parents: 'text/plain'},
+    {mimetype: 'application/js', extensions: %w(map), parents: 'text/plain'},
+    {mimetype: 'application/vnd.ms-fontobject', extensions: %w(eot)},
+    {mimetype: 'image/svg+xml', extensions: %w(svg svgz)}
+  ]
+
+  def self.configureMimeMagic
+    ShopifyTheme::EXTENSIONS.each do |extension|
+      MimeMagic.add(extension.delete(:mimetype), extension)
+    end
+  end
+
+  class Cli < Thor
+    include Thor::Actions
+
+    IGNORE = %w(config.yml)
+    DEFAULT_WHITELIST = %w(layout/ assets/ config/ snippets/ templates/ locales/)
+    TIMEFORMAT = "%H:%M:%S"
+
+    tasks.keys.abbrev.each do |shortcut, command|
+      map shortcut => command.to_sym
+    end
+
+    desc "check", "check configuration"
+    def check
+      if ShopifyTheme.check_config
+        say("Configuration [OK]", :green)
+      else
+        say("Configuration [FAIL]", :red)
+      end
+    end
+
+    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}
+      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
+    def download(*keys)
+      assets = keys.empty? ? ShopifyTheme.asset_list : keys
+
+      if options['exclude']
+        assets = assets.delete_if { |asset| asset =~ Regexp.new(options['exclude']) }
+      end
+
+      assets.each do |asset|
+        download_asset(asset)
+        say("#{ShopifyTheme.api_usage} Downloaded: #{asset}", :green) unless options['quiet']
+      end
+      say("Done.", :green) unless options['quiet']
+    end
+
+    desc "open", "open the store in your browser"
+    def open(*keys)
+      if Launchy.open shop_theme_url
+        say("Done.", :green)
+      end
+    end
+
+    desc "upload FILE", "upload all theme assets to shop"
+    method_option :quiet, :type => :boolean, :default => false
+    def upload(*keys)
+      assets = keys.empty? ? local_assets_list : keys
+      assets.each do |asset|
+        send_asset(asset, options['quiet'])
+      end
+      say("Done.", :green) unless options['quiet']
+    end
+
+    desc "replace FILE", "completely replace shop theme assets with local theme assets"
+    method_option :quiet, :type => :boolean, :default => false
+    def replace(*keys)
+      say("Are you sure you want to completely replace your shop theme assets? This is not undoable.", :yellow)
+      if ask("Continue? (Y/N): ") == "Y"
+        # only delete files on remote that are not present locally
+        # files present on remote and present locally get overridden anyway
+        remote_assets = keys.empty? ? (ShopifyTheme.asset_list - local_assets_list) : keys
+        remote_assets.each do |asset|
+          delete_asset(asset, options['quiet']) unless ShopifyTheme.ignore_files.any? { |regex| regex =~ asset }
+        end
+        local_assets = keys.empty? ? local_assets_list : keys
+        local_assets.each do |asset|
+          send_asset(asset, options['quiet'])
+        end
+        say("Done.", :green) unless options['quiet']
+      end
+    end
+
+    desc "remove FILE", "remove theme asset"
+    method_option :quiet, :type => :boolean, :default => false
+    def remove(*keys)
+      keys.each do |key|
+        delete_asset(key, options['quiet'])
+      end
+      say("Done.", :green) unless options['quiet']
+    end
+
+    desc "watch", "upload and delete individual theme assets as they change, use the --keep_files flag to disable remote file deletion"
+    method_option :quiet, :type => :boolean, :default => false
+    method_option :keep_files, :type => :boolean, :default => false
+    def watch
+      puts "Watching current folder: #{Dir.pwd}"
+      watcher do |filename, event|
+        filename = filename.gsub("#{Dir.pwd}/", '')
+
+        next unless local_assets_list.include?(filename)
+        action = if [:changed, :new].include?(event)
+          :send_asset
+        elsif event == :delete
+          :delete_asset
+        else
+          raise NotImplementedError, "Unknown event -- #{event} -- #{filename}"
+        end
+
+        send(action, filename, options['quiet'])
+      end
+    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)}
+        @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)
+      end
+    end
+
+    def download_asset(key)
+      return unless valid?(key)
+      notify_and_sleep("Approaching limit of API permits. Naptime until more permits become available!") if ShopifyTheme.needs_sleep?
+      asset = ShopifyTheme.get_asset(key)
+      if asset['value']
+        # For CRLF line endings
+        content = asset['value'].gsub("\r", "")
+        format = "w"
+      elsif asset['attachment']
+        content = Base64.decode64(asset['attachment'])
+        format = "w+b"
+      end
+
+      FileUtils.mkdir_p(File.dirname(key))
+      File.open(key, format) {|f| f.write content} if content
+    end
+
+    def send_asset(asset, quiet=false)
+      return unless valid?(asset)
+      data = {:key => asset}
+      content = File.read(asset)
+      if binary_file?(asset) || ShopifyTheme.is_binary_data?(content)
+        content = File.open(asset, "rb") { |io| io.read }
+        data.merge!(:attachment => Base64.encode64(content))
+      else
+        data.merge!(:value => content)
+      end
+
+      response = show_during("[#{timestamp}] Uploading: #{asset}", quiet) do
+        ShopifyTheme.send_asset(data)
+      end
+      if response.success?
+        say("[#{timestamp}] Uploaded: #{asset}", :green) unless quiet
+      else
+        report_error(Time.now, "Could not upload #{asset}", response)
+      end
+    end
+
+    def delete_asset(key, quiet=false)
+      return unless valid?(key)
+      response = show_during("[#{timestamp}] Removing: #{key}", quiet) do
+        ShopifyTheme.delete_asset(key)
+      end
+      if response.success?
+        say("[#{timestamp}] Removed: #{key}", :green) unless quiet
+      else
+        report_error(Time.now, "Could not remove #{key}", response)
+      end
+    end
+
+    def notify_and_sleep(message)
+      say(message, :red)
+      ShopifyTheme.sleep
+    end
+
+    def valid?(key)
+      return true if DEFAULT_WHITELIST.include?(key.split('/').first + "/")
+      say("'#{key}' is not in a valid file for theme uploads", :yellow)
+      say("Files need to be in one of the following subdirectories: #{DEFAULT_WHITELIST.join(' ')}", :yellow)
+      false
+    end
+
+    def binary_file?(path)
+      mime = MimeMagic.by_path(path)
+      say("'#{path}' is an unknown file-type, uploading asset as binary", :yellow) if mime.nil? && ENV['TEST'] != 'true'
+      mime.nil? || !mime.text?
+    end
+
+    def report_error(time, message, response)
+      say("[#{timestamp(time)}] Error: #{message}", :red)
+      say("Error Details: #{errors_from_response(response)}", :yellow)
+    end
+
+    def errors_from_response(response)
+      object = {status: response.headers['status'], request_id: response.headers['x-request-id']}
+
+      errors = response.parsed_response ? response.parsed_response["errors"] : response.body
+
+      object[:errors] = case errors
+                        when NilClass
+                          ''
+                        when String
+                          errors.strip
+                        else
+                          errors.values.join(", ")
+                        end
+      object.delete(:errors) if object[:errors].length <= 0
+      object
+    end
+
+    def show_during(message = '', quiet = false, &block)
+      print(message) unless quiet
+      result = yield
+      print("\r#{' ' * message.length}\r") unless quiet
+      result
+    end
+
+    def timestamp(time = Time.now)
+      time.strftime(TIMEFORMAT)
+    end
+  end
+end
+ShopifyTheme.configureMimeMagic

data/lib/shopify_theme/version.rb

@@ -0,0 +1,3 @@
+module ShopifyTheme
+  VERSION = "0.0.21"
+end

data/shipit.rubygems.yml

@@ -0,0 +1 @@
+# using the default shipit config

data/shopify_theme.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shopify_theme/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dev_shopify_theme"
+  s.version     = ShopifyTheme::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Duff", "Lawson Kurtz"]
+  s.email       = ["john.duff@shopify.com", "lawson.kurtz@viget.com"]
+  s.homepage    = "https://github.com/ltk/shopify_theme"
+  s.summary     = %q{*Insecure* command line tool for developing themes (Dev env only!)}
+  s.description = %q{*Insecure* 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. (Dev env only!)}
+  s.license     = 'MIT'
+
+  s.add_dependency('thor', '>= 0.14.4')
+  s.add_dependency('httparty', '~> 0.13.0')
+  s.add_dependency('json', '~> 1.8.0')
+  s.add_dependency('mimemagic')
+  s.add_dependency('filewatcher')
+  s.add_dependency('launchy')
+
+  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")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+ENV['TEST'] = 'true'
+require 'minitest/autorun'
+require 'pry'
+require 'pry-debugger'

data/spec/unit/cli_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'shopify_theme'
+require 'shopify_theme/cli'
+
+module ShopifyTheme
+  describe "Cli" do
+
+    class CliDouble < Cli
+      attr_writer :local_files, :mock_config
+
+      desc "",""
+      def config
+        @mock_config || super
+      end
+
+      desc "",""
+      def shop_theme_url
+        super
+      end
+
+      desc "",""
+      def binary_file?(file)
+        super
+      end
+
+      desc "", ""
+      def local_files
+        @local_files
+      end
+    end
+
+    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', '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')
+    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
+      @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
+
+    it "should report binary files as such" do
+      extensions = %w(png gif jpg jpeg eot svg ttf woff otf swf ico pdf)
+      extensions.each do |ext|
+        assert @cli.binary_file?("hello.#{ext}"), "#{ext.upcase}s are binary files"
+      end
+    end
+
+    it "should report unknown files as binary files" do
+      assert @cli.binary_file?('omg.wut'), "Unknown filetypes are assumed to be binary"
+    end
+
+    it "should not report text based files as binary" do
+      refute @cli.binary_file?('theme.liquid'), "liquid files are not binary"
+      refute @cli.binary_file?('style.sass.liquid'), "sass.liquid files are not binary"
+      refute @cli.binary_file?('style.css'), 'CSS files are not binary'
+      refute @cli.binary_file?('application.js'), 'Javascript files are not binary'
+      refute @cli.binary_file?('settings_data.json'), 'JSON files are not binary'
+      refute @cli.binary_file?('applicaton.js.map'), 'Javascript Map files are not binary'
+    end
+  end
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: dev_shopify_theme
+version: !ruby/object:Gem::Version
+  version: 0.0.21
+platform: ruby
+authors:
+- John Duff
+- Lawson Kurtz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !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: '*Insecure* 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.
+  (Dev env only!)'
+email:
+- john.duff@shopify.com
+- lawson.kurtz@viget.com
+executables:
+- dev-theme
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- CONTRIBUTING
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/dev-theme
+- doc/how_to_find_theme_id.png
+- lib/shopify_theme.rb
+- lib/shopify_theme/cli.rb
+- lib/shopify_theme/version.rb
+- shipit.rubygems.yml
+- shopify_theme.gemspec
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
+homepage: https://github.com/ltk/shopify_theme
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: '*Insecure* command line tool for developing themes (Dev env only!)'
+test_files:
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
+has_rdoc: