bodega-shopify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9a57c9aec549e887c631c76407c1d95d0321bb3
+  data.tar.gz: ca4041319ed4862e1c37c45e56d2874e763dc7bb
+SHA512:
+  metadata.gz: b7f66a21d96f135f9abf9d3b045c2837fafe62948caa5fc23fd514883b107c3b876ceca079dac34bab1c4e85eec875b11ac1f7f81c96a691cc000ff4e60c088b
+  data.tar.gz: bffb484c9a5b538ecb676b316c35e3933e5d01209bd89d7842bb0e9971ac9db4f277f88edd7339222e0070e6d63818692e0876d2d8ad62d27069b04e7f08eb7b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/assets
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michael Dijkstra
+
+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,55 @@
+# Bodega — A Shopify Workflow Gem
+
+Bodega makes it easier for developers and designers to develop themes and deploy stores on Shopify.
+
+## Benefits
+
++ Use your text editor of choice to edit theme files
++ Automatically keep theme files in sync
++ Manage multiple shops and themes at once
++ Easily switch between multiple themes/stores
+
+## Features
+
+1. Sync local theme files with live Shopify stores using the [Shopify Theme gem](https://github.com/Shopify/shopify_theme/)
+2. Deploy your theme to development and production stores
+
+## Planned Features
+
++ Copy products, collections, pages, blogs and articles between Shopify stores
+
+## Installation
+
+```
+gem install bodega-shopify
+```
+
+## The Bodega Workflow
+
+1. `cd` into your theme folder
+2. Run `$ bodega bootstrap`
+4. Setup your bodega config file ([See instructions](https://github.com/XXIX/bodega/wiki/Theme-and-Store-Requirements))
+5. Replace your development store with your theme by running: `$ bodega replace_theme`
+6. Watch and sync your theme folder by running:  `$ bodega watch`
+7. Edit your theme files
+8. Sync updates with production by running: `$ bodega sync_theme production`
+
+## Building Locally
+
+1. Clone it
+2. Run `bundle`
+3. Run `rake install`
+
+## Publishing
+
+1. Update the version number in `lib/bodega-shopify/version.rb`
+2. Run `gem build bodega-shopify.gemspec`
+3. Run `gem push bodega-shopify-0.0.X.gem`
+
+## Contributing
+
+1. Fork it ( https://github.com/xxix/bodega-gem/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/bodega

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'bodega-shopify'
+
+def help
+  %Q(
+  Usage: bodega [COMMAND]
+
+  Commands:
+    bootstrap, bootstrap [FOLDER]   Setup folder with default files
+    sync_theme [ENVIRONMENT]        Push files modified since last sync to Shopify
+    replace_theme [ENVIRONMENT]     Replace theme on Shopify
+    watch [ENVIRONMENT]             Watch for changes and push to Shopify
+    help                            Prints this help document
+    version                         Prints the bodega shopify gem version
+
+  Options:
+    -h, --help                      Prints this help document
+    -v, --version                   Prints the bodega shopify gem version
+
+  See https://github.com/xxix/bodega-shopify-gem for additional documentation.
+  )
+end
+
+def bootstrap folder=nil
+  builder = BodegaShopify::Builder.new
+  builder.setup folder
+end
+
+def replace_theme environment='development'
+  config = BodegaShopify::Configuration.new environment: environment
+  syncer = BodegaShopify::Syncer.new(config: config)
+  syncer.replace!
+end
+
+def sync_theme environment='development'
+  config = BodegaShopify::Configuration.new environment: environment
+  syncer = BodegaShopify::Syncer.new(config: config)
+  syncer.sync!
+end
+
+def watch environment='development'
+  config = BodegaShopify::Configuration.new environment: environment
+  syncer = BodegaShopify::Syncer.new(config: config)
+  syncer.watch
+end
+
+case ARGV[0]
+when '-v', '--version', 'version'
+  puts BodegaShopify::VERSION
+when '-h', '--help', 'help'
+  puts help
+when 'bootstrap'
+  bootstrap ARGV[1]
+when 'replace_theme'
+  replace_theme ARGV[1]
+when 'sync_theme'
+  sync_theme ARGV[1]
+when 'watch'
+  watch ARGV[1]
+else
+  puts "`#{ARGV[0]}` command not found.\n"
+  puts help
+end

data/bodega-shopify.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bodega-shopify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bodega-shopify"
+  spec.version       = BodegaShopify::VERSION
+  spec.authors       = ["Michael Dijkstra"]
+  spec.email         = ["michael@xxix.co"]
+  spec.summary       = "A Shopify workflow gem"
+  spec.description   = "Bodega makes it easier for developers and designers to develop themes and deploy stores on Shopify."
+  spec.homepage      = "https://github.com/xxix/bodega-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ['bodega']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "shopify_theme", '~> 0.0'
+  spec.add_runtime_dependency "shopify_api", '~> 3.2'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

data/lib/bodega-shopify.rb

@@ -0,0 +1,9 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require "bodega-shopify/version"
+require "bodega-shopify/constants"
+require "bodega-shopify/configuration"
+require "bodega-shopify/logger"
+require "bodega-shopify/builder"
+require "bodega-shopify/syncer"

data/lib/bodega-shopify/builder.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module BodegaShopify
+  class Builder
+    attr_accessor :folder
+
+    def initialize
+    end
+
+    def setup folder=nil
+      self.folder = "#{folder.chomp("/").reverse.chomp("/").reverse}/" if folder
+      setup_directory folder_path
+      setup_config
+    end
+
+    def folder_path
+      "#{ROOT}/#{folder}"
+    end
+
+    private
+
+    def src_directory
+      spec = Gem::Specification.find_by_name("bodega-shopify")
+      "#{spec.gem_dir}/src/"
+    end
+
+    def create_src_file source, destination
+      unless File.exists?(destination)
+        contents = File.open("#{src_directory}#{source}").read
+        File.open(destination, 'w') { |file| file.write(contents) }
+        BodegaShopify.logger.info "created #{destination}"
+      end
+    end
+
+    def setup_directory path
+      unless File.exists?(path)
+        Dir.mkdir(path)
+        SmallVictories.logger.info "created #{path}"
+      end
+    end
+
+    def setup_config
+      create_src_file('bodega.yml', File.join(folder_path, '_bodega.yml'))
+      create_src_file('config.yml', File.join(folder_path, 'config.yml'))
+    end
+  end
+end

data/lib/bodega-shopify/configuration.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+module BodegaShopify
+  class Configuration
+    attr_accessor :shopify_config, :environment, :config
+
+    def initialize params={}
+      self.environment = (params[:environment] || DEFAULT_ENVIRONMENT).to_sym
+      self.config = File.exists?(CONFIG_FILE) ? YAML.load(File.read(CONFIG_FILE)) || {} : {}
+      self.shopify_config = File.exists?(SHOPIFY_CONFIG_FILE) ? YAML.load(File.read(SHOPIFY_CONFIG_FILE)) || {} : {}
+      BodegaShopify.logger.info "Configured #{environment} store #{store}"
+      save_shopify_config
+    end
+
+    def config_file key
+      config[key.to_s].to_s.chomp("/").reverse.chomp("/").reverse if config.has_key?(key.to_s)
+    end
+
+    def api_key
+      config[environment][:api_key]
+    end
+
+    def password
+      config[environment][:password]
+    end
+
+    def store
+      config[environment][:store]
+    end
+
+    def ignore_files
+      (shopify_config[:ignore_files] || []).compact.map { |r| Regexp.new(r) }
+    end
+
+    def last_sync_at
+      config[environment][:last_sync_at] ||= Time.parse('2000-01-01 00:00:00')
+    end
+
+    def last_sync_at= last_sync_at
+      config[environment][:last_sync_at] = last_sync_at
+    end
+
+    def save
+      File.open(CONFIG_FILE, 'w') {|f| f.write config.to_yaml }
+    end
+
+    def save_shopify_config
+      shopify_config[:api_key] = api_key
+      shopify_config[:password] = password
+      shopify_config[:store] = store
+      File.open(SHOPIFY_CONFIG_FILE, 'w') {|f| f.write shopify_config.to_yaml }
+    end
+  end
+end

data/lib/bodega-shopify/constants.rb

@@ -0,0 +1,6 @@
+module BodegaShopify
+  CONFIG_FILE = '_bodega.yml'
+  SHOPIFY_CONFIG_FILE = 'config.yml'
+  DEFAULT_ENVIRONMENT = :development
+  ROOT = Dir.pwd
+end

data/lib/bodega-shopify/logger.rb

@@ -0,0 +1,25 @@
+require 'logger'
+
+module BodegaShopify
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = self.name
+        log.formatter = proc do |severity, datetime, progname, msg|
+          string = "Bodega: "
+          case severity
+          when 'INFO'
+            string.concat("👍  ")
+          when 'WARN'
+            string.concat("⚠️  ")
+          when 'ERROR'
+            string.concat("🔥  ")
+          end
+          string.concat("#{msg}\n")
+        end
+      end
+    end
+  end
+end

data/lib/bodega-shopify/syncer.rb

@@ -0,0 +1,43 @@
+require 'shopify_theme'
+require 'shopify_theme/cli'
+
+module BodegaShopify
+  class Syncer
+    attr_accessor :config
+
+    def initialize params={}
+      self.config = params[:config]
+    end
+
+    def cli
+      @cli ||= ShopifyTheme::Cli.new
+    end
+
+    def files
+      Dir["**/*"]
+    end
+
+    def modified_files
+      files.select{ |file| !(config.ignore_files.any? { |ignore| file =~ /^#{ignore}/ } || File.directory?(file) || File.mtime(file).to_i < config.last_sync_at.to_time.to_i) }
+    end
+
+    def replace!
+      cli.replace
+      cli.upload 'config/settings_data.json'
+    end
+
+    def save_config
+      config.last_sync_at = Time.now
+      config.save
+    end
+
+    def sync!
+      modified_files.each { |file| cli.upload file }
+      save_config
+    end
+
+    def watch
+      cli.watch
+    end
+  end
+end

data/lib/bodega-shopify/version.rb

@@ -0,0 +1,3 @@
+module BodegaShopify
+  VERSION = "0.0.1"
+end

data/spec/builder_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe BodegaShopify do
+  let(:builder) { BodegaShopify::Builder.new }
+
+  context 'with folder' do
+    it 'sets up default files' do
+      builder.setup 'spec/fixtures/new'
+      expect(File.exists?('fixtures/new/_bodega.yml')).to eq true
+      expect(File.exists?('fixtures/new/config.yml')).to eq true
+    end
+
+    after do
+      %w(fixtures/new/_bodega.yml fixtures/new/config.yml).each { |path| clean_file(path) }
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe BodegaShopify do
+  let(:configuration) { BodegaShopify::Configuration.new }
+
+  context 'with config file' do
+    before do
+      FileUtils.cp('fixtures/_bodega.yml', './')
+    end
+
+    it 'defaults to development environment' do
+      expect(configuration.environment).to eq :development
+    end
+
+    it 'loads development api key' do
+      expect(configuration.api_key).to eq 'dev-api-key'
+    end
+
+    it 'loads development password' do
+      expect(configuration.password).to eq 'dev-password'
+    end
+
+    it 'loads development store' do
+      expect(configuration.store).to eq 'dev-store'
+    end
+
+    context 'with shopify config file' do
+      before do
+        FileUtils.cp('fixtures/config.yml', './')
+      end
+
+      it 'sets api key' do
+        expect(configuration.shopify_config[:api_key]).to eq configuration.api_key
+      end
+
+      it 'sets password' do
+        expect(configuration.shopify_config[:password]).to eq configuration.password
+      end
+
+      it 'sets store' do
+        expect(configuration.shopify_config[:store]).to eq configuration.store
+      end
+    end
+
+    context 'for production' do
+      let(:production_configuration) { BodegaShopify::Configuration.new environment: :production }
+
+      it 'defaults to development environment' do
+        expect(production_configuration.environment).to eq :production
+      end
+
+      it 'loads production api key' do
+        expect(production_configuration.api_key).to eq 'prod-api-key'
+      end
+
+      it 'loads production password' do
+        expect(production_configuration.password).to eq 'prod-password'
+      end
+
+      it 'loads production store' do
+        expect(production_configuration.store).to eq 'prod-store'
+      end
+    end
+  end
+end

data/spec/fixtures/_bodega.yml

@@ -0,0 +1,9 @@
+---
+:production:
+  :api_key: prod-api-key
+  :password: prod-password
+  :store: prod-store
+:development:
+  :api_key: dev-api-key
+  :password: dev-password
+  :store: dev-store

data/spec/fixtures/config.yml

@@ -0,0 +1,6 @@
+---
+:ignore_files:
+- config/settings_data.json
+- README.md
+- bodega.yml
+- config.yml

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'bodega-shopify'
+
+RSpec.configure do |config|
+  config.before do
+    FileUtils.cd File.dirname(__FILE__)
+  end
+
+  config.after do
+    %w(./_bodega.yml ./config.yml).each { |path| clean_file(path) }
+  end
+end
+
+def clean_file path
+  FileUtils.rm(path) if File.exists?(path)
+end

data/src/bodega.yml

@@ -0,0 +1,9 @@
+---
+:production:
+  :api_key:
+  :password:
+  :store:
+:development:
+  :api_key:
+  :password:
+  :store:

data/src/config.yml

@@ -0,0 +1,7 @@
+---
+:ignore_files:
+- _/**/*
+- config/settings_data.json
+- README.md
+- _bodega.yml
+- config.yml

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: bodega-shopify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Dijkstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_theme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Bodega makes it easier for developers and designers to develop themes
+  and deploy stores on Shopify.
+email:
+- michael@xxix.co
+executables:
+- bodega
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bodega
+- bodega-shopify.gemspec
+- lib/bodega-shopify.rb
+- lib/bodega-shopify/builder.rb
+- lib/bodega-shopify/configuration.rb
+- lib/bodega-shopify/constants.rb
+- lib/bodega-shopify/logger.rb
+- lib/bodega-shopify/syncer.rb
+- lib/bodega-shopify/version.rb
+- spec/builder_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/.gitkeep
+- spec/fixtures/_bodega.yml
+- spec/fixtures/config.yml
+- spec/spec_helper.rb
+- src/bodega.yml
+- src/config.yml
+homepage: https://github.com/xxix/bodega-gem
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Shopify workflow gem
+test_files:
+- spec/builder_spec.rb
+- spec/configuration_spec.rb
+- spec/fixtures/.gitkeep
+- spec/fixtures/_bodega.yml
+- spec/fixtures/config.yml
+- spec/spec_helper.rb