guard-shopifytheme 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d75196e46a59d89b3df668247fbd0fe02523add
-  data.tar.gz: 7e23a474fa58b952427fa144202ac127eb227944
+  metadata.gz: 4d31aefcef6082c67442abeb7ead176cf5874ae7
+  data.tar.gz: 7af764a6789900ada1b510888928ee158e21ac92
 SHA512:
-  metadata.gz: e11169d4877ffe1fd78b8c8065fc3e9cd4b34e0781579c5712298aef99d9bbbbe7ba28f8a25c36756ce1f7f4a0cdf3d3f802f6019a6139989f01f7f00cde111e
-  data.tar.gz: d3ece44bcb79a8ded45828ca1e2c3c70607ab47ccdfb821eb05666199115721d6abb567becc757e10529c4c93d0597b259164f31da9ed0ac30d7e399c3f7937e
+  metadata.gz: f6146e260185493196ad50ad8fdf35c616194b6246a22ebc3555fab3c77def87078961a9d64741c01f1e067ac89e6fc7c9e47aa199d3665a9237093c629c7105
+  data.tar.gz: a1815f08dda82184467371259a4fa6b4c1bfcacd88aa2a50b437c023735433fccd1472a75f0e2664c388506c2a8a0906a2780df3bcea635f46b69a5be3d91bf0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Danny Smith
+
+MIT License
+
+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,103 @@
+# Guard::Shopifytheme
+[![Build Status](https://travis-ci.org/dannysmith/guard-shopifytheme.png?branch=master)](https://travis-ci.org/dannysmith/guard-shopifytheme) [![Gem Version](https://badge.fury.io/rb/guard-shopifytheme.png)](http://badge.fury.io/rb/guard-shopifytheme)
+
+Uses [Guard](https://github.com/guard/guard) to watch for changes and update Shopify when a file is changed. Very similar functionality to [guard-shopify](https://github.com/1337807/guard-shopify), except that it uses the [shopify_theme](https://github.com/Shopify/shopify_theme) gem to do most of the work. This has a couple of advantages:
+
+* shopify_theme is maintained by Shopify, so will usually be up-to-date.
+* The config settings are stored in the project directory (rather than in `~/.guard_shopify`, as with guatd-shopify)
+* If you choose to use the `theme watch` command provided by shopify_theme instead of Guard, then everything will still work properly – you don't need to maintain two sets of config files.
+
+## Installation
+Make sure you have installed [Guard](https://github.com/guard/guard).
+
+Add this line to your application's Gemfile:
+
+    gem 'guard-shopifytheme'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install guard-shopifytheme
+
+If you don't already have [shopify_theme](https://github.com/Shopify/shopify_theme) set up, create a `config.yml` file in your project directory (see [here](https://github.com/Shopify/shopify_theme#usage)):
+
+````yaml
+---
+:api_key: YOUR_API_KEY
+:password: YOUR_PASSWORD
+:store: YOURSHOP.myshopify.com
+:theme_id: 'YOUR_THEME_ID'
+:ignore_files:
+- README.md
+- CHANGELOG.md
+````
+
+Add the Guard definition to your Guardfile with:
+
+    $ guard init guard-shopifytheme
+
+## Usage
+There aren't any options, so usage is pretty simple:
+
+````ruby
+# Upload Changes to Shopify
+guard :shopifytheme do
+  watch(/assets\/.*/)
+  watch(/config\/.*/)
+  watch(/layout\/.*/)
+  watch(/snippets\/.*/)
+  watch(/templates\/.*/)
+end
+````
+
+
+## An Alternative
+If you don't want to install this gem, you can just add this to your Guardfile:
+
+````ruby
+require 'guard/plugin'
+
+module ::Guard
+  class ShopifyTheme < ::Guard::Plugin
+    def run_all
+    end
+
+    def start
+    end
+
+    def run_on_changes(paths)
+      paths.each do |path|
+        system "theme upload #{path}"
+      end
+    end
+
+    def run_on_removals(paths)
+      paths.each do |path|
+        system "theme remove #{path}"
+      end
+    end
+  end
+end
+````
+
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Todo
+- Add some tests
+- Improve `start()` to ask for your shopify API details and write them to config.yml
+
+## Author
+- Danny Smith ([@dannysmith](http://github.com/dannysmith))
+- Shopfy_Theme by Shopify ([@shopify](https://github.com/Shopify))
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/dannysmith/guard-shopifytheme/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+task :default => [:test]
+
+task :test do
+  puts "No tests yet"
+end

data/guard-shopifytheme.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guard/shopifytheme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "guard-shopifytheme"
+  spec.version       = Guard::ShopifythemeVersion::VERSION
+  spec.authors       = ["Danny Smith"]
+  spec.email         = ["danny@dasmith.co.uk"]
+  spec.description   = %q{Guard::Shopifytheme uses shopify_theme to update shopify when watched files are modified}
+  spec.summary       = %q{Guard gem for updating shopify through shopify_theme}
+  spec.homepage      = "http://github.com/dannysmith/guard-shopifytheme"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path  = 'lib'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "shopify_theme", '>= 0.0.13'
+  spec.add_dependency "guard", '~> 2.0'
+end

data/lib/guard/shopifytheme.rb

@@ -0,0 +1,106 @@
+require 'guard'
+require 'guard/plugin'
+# require "guard/shopifytheme/version"
+
+
+module Guard
+  class Shopifytheme < Plugin
+
+    #VERSION = "0.0.1"
+
+    def initialize(options = {})
+      super
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+     if File.exist? 'config.yml'
+        Notifier.notify "Watching for changes to Shopify Theme"
+      else
+        data = <<-EOF
+---
+:api_key: YOUR_API_KEY
+:password: YOUR_PASSWORD
+:store: YOURSHOP.myshopify.com
+:theme_id: 'YOUR_THEME_ID'
+:ignore_files:
+- README.md
+- CHANGELOG.md
+EOF
+        File.open('./config.yml', "w") { |file| file.write data }
+        Notifier.notify "Created config.yml. Remember to add your Shopify details to it."
+      end
+    end
+
+    # Called when `stop|quit|exit|s|q|e + enter` is pressed (when Guard quits).
+    #
+    # @raise [:task_has_failed] when stop has failed
+    # @return [Object] the task result
+    #
+    # def stop
+    # end
+
+    # Called when `reload|r|z + enter` is pressed.
+    # This method should be mainly used for "reload" (really!) actions like reloading passenger/spork/bundler/...
+    #
+    # @raise [:task_has_failed] when reload has failed
+    # @return [Object] the task result
+    #
+    # def reload
+    # end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    # def run_all
+    # end
+
+    # Default behaviour on file(s) changes that the Guard plugin watches.
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_change has failed
+    # @return [Object] the task result
+    #
+    def run_on_changes(paths)
+      paths.each do |path|
+        system "theme upload #{path}"
+      end
+    end
+
+    # Called on file(s) additions that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_additions has failed
+    # @return [Object] the task result
+    #
+    # def run_on_additions(paths)
+    # end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    #
+    # def run_on_modifications(paths)
+    # end
+
+    # Called on file(s) removals that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_removals has failed
+    # @return [Object] the task result
+    #
+    def run_on_removals(paths)
+      paths.each do |path|
+        system "theme remove #{path}"
+      end
+    end
+  end
+end

data/lib/guard/shopifytheme/templates/Guardfile

@@ -0,0 +1,8 @@
+# Upload Changes to Shopify
+guard :shopifytheme do
+  watch(/assets\/.*/)
+  watch(/config\/.*/)
+  watch(/layout\/.*/)
+  watch(/snippets\/.*/)
+  watch(/templates\/.*/)
+end

data/lib/guard/shopifytheme/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module ShopifythemeVersion
+    VERSION = "0.0.2"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-shopifytheme
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,7 +73,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guard-shopifytheme.gemspec
+- lib/guard/shopifytheme.rb
+- lib/guard/shopifytheme/templates/Guardfile
+- lib/guard/shopifytheme/version.rb
 homepage: http://github.com/dannysmith/guard-shopifytheme
 licenses:
 - MIT