dugway 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edbd573f45d273fb7750817bf39cdd458a27f869
-  data.tar.gz: 3fa990884467e68bd017b1d4dba5f88a4ebb3c92
+  metadata.gz: 826b2f5eb8927caa43d20178107cad6e51811bb4
+  data.tar.gz: 04baf16d2887144b19ae7664f7079df41f496577
 SHA512:
-  metadata.gz: 34471b9191164aed5bbfef6f2c6b32c09eef14827f63f618b99d65db658a37803052e766157f7b6336d4cb4325465a14223d7f28010f5e312e95381617d88c41
-  data.tar.gz: 7df031699ef5ac1d65d5e5972ba7ed434285c55f1d4090e4b7c6ee3c5f10ce3a40e78bdc32c31f60ec899b6682c8e2a5d41c9742550918c8d729650a7ad846ac
+  metadata.gz: 3c1e3f431703966b86aedb8e8291c0b8d315e28e6f60f54577d589704dc6214f0bed02eb125776816abe59c94149accae6e16a1dd189cef86216292434e95de3
+  data.tar.gz: f596dfb2520ea4f54e306c6b28ca94f676b6b1b789f1250b1676c417099c4e7593c19db3798e7b3775898cbf0b9a7f2d870c1be930d90ef42ae9371510b5b0e6

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+cache: bundler
+sudo: false
 rvm:
   - 1.9.3
   - 2.0

data/CHANGELOG.md

@@ -1,16 +1,36 @@
 ## Version History
 
+#### 0.10.3
+
+* Added `.dugway.json` as a better way to [test your theme](https://github.com/bigcartel/dugway#testing-your-theme) without needing to modify `config.ru`
+
+#### 0.10.2
+
+* Misc bug fixes and improvements
+
+#### 0.10.1
+
+* Misc bug fixes and improvements
+
+#### 0.10.0
+
+* Added support for default images in `settings.json`
+
 #### 0.9.0
- * Added support for `theme_font_url` liquid filter
- * Added fonts directory, serve fonts from there
- * `dugway build` will include font files in the zip
+
+* Added support for `theme_font_url` liquid filter
+* Added fonts directory, serve fonts from there
+* `dugway build` will include font files in the zip
 
 #### 0.8.4
- * Support `image_sets` in `settings.json`
- * Support the new [constrain](http://help.bigcartel.com/developers/themes/#constrainurl-width-height) filter
+
+* Support `image_sets` in `settings.json`
+* Support the new [constrain](http://help.bigcartel.com/developers/themes/#constrainurl-width-height) filter
 
 #### 0.7.0
- * Rename `scripts.js` and `styles.css` to `theme.js` and `theme.css`
+
+* Rename `scripts.js` and `styles.css` to `theme.js` and `theme.css`
 
 #### Pre-0.7.0
- * Initial launch and bug fixes
+
+* Initial launch and bug fixes

data/README.md

@@ -20,41 +20,46 @@ Dugway allows you to run your Big Cartel theme on your computer, test it in any
 
 Dugway is Ruby gem so you'll need to have Ruby 1.9.3+ installed. Ruby is usually pre-installed on Mac OS X and Linux, and Windows users can install it using [RubyInstaller](http://rubyinstaller.org). From there, simply install the **dugway** gem from the terminal.
 
-    gem install dugway
+```
+gem install dugway
+```
 
 ## Creating a new theme
 
 With Dugway installed, you can now create a new theme, simply give it a name.
 
-    dugway create mytheme
+```
+dugway create mytheme
+```
 
 This will create a new directory named *mytheme* that contains a few configuration files and a starter theme to get you going.
 
-    mytheme
-    ├── source
-    |   ├── fonts
-    │   │   └── all font files for your theme
-    │   ├── images
-    │   │   └── all image files for your theme
-    │   ├── javascripts
-    │   │   └── all JavaScript files for your theme
-    │   ├── stylesheets
-    │   │   └── all CSS files for your theme
-    │   ├── cart.html
-    │   ├── checkout.html
-    │   ├── contact.html
-    │   ├── home.html
-    │   ├── layout.html
-    │   ├── maintenance.html
-    │   ├── product.html
-    │   ├── products.html
-    │   ├── screenshot.jpg
-    │   ├── settings.json
-    │   ├── success.html
-    │   ├── theme.css
-    │   └── theme.js
-    └── config.ru
-
+```
+mytheme
+├── source
+|   ├── fonts
+│   │   └── all font files for your theme
+│   ├── images
+│   │   └── all image files for your theme
+│   ├── javascripts
+│   │   └── all JavaScript files for your theme
+│   ├── stylesheets
+│   │   └── all CSS files for your theme
+│   ├── cart.html
+│   ├── checkout.html
+│   ├── contact.html
+│   ├── home.html
+│   ├── layout.html
+│   ├── maintenance.html
+│   ├── product.html
+│   ├── products.html
+│   ├── screenshot.jpg
+│   ├── settings.json
+│   ├── success.html
+│   ├── theme.css
+│   └── theme.js
+└── config.ru
+```
 
 ## Developing your theme
 
@@ -74,15 +79,19 @@ All CSS for your theme is handled by the **theme.css** file, and all JavaScript
 
 ##### theme.css
 
-    /*
-     *= require stylesheets/example_1
-     *= require stylesheets/example_2
-     */
+```css
+/*
+ *= require stylesheets/example_1
+ *= require stylesheets/example_2
+ */
+```
 
 ##### theme.js
 
-    //= require javascripts/example_1
-    //= require javascripts/example_2
+```js
+//= require javascripts/example_1
+//= require javascripts/example_2
+```
 
 #### Using Sass, Compass, LESS, and CoffeeScript
 
@@ -98,23 +107,31 @@ You can embed the CSS and JavaScript into your theme by passing the theme variab
 
 ##### CSS (theme.css)
 
-    <link href="{{ theme | theme_css_url }}" media="screen" rel="stylesheet" type="text/css">
+```html
+<link href="{{ theme | theme_css_url }}" media="screen" rel="stylesheet" type="text/css">
+```
 
 ##### JavaScript (theme.js)
 
-    <script src="{{ theme | theme_js_url }}" type="text/javascript"></script>
+```html
+<script src="{{ theme | theme_js_url }}" type="text/javascript"></script>
+```
 
 ### Images
 
 And as you've probably guessed by now, all images for your theme go in the **images** directory. You can reference an image in your code by passing its name to the [theme_image_url](http://help.bigcartel.com/developers/themes/#themeimageurlname) filter.
 
-    {{ 'sample.png' | theme_image_url }}
+```
+{{ 'sample.png' | theme_image_url }}
+```
 
 ### Fonts
 
 Fonts work more or less the same as images. Place font files (say if you have created a custom icon font) in the **fonts** directory. Reference them by passing its name to the `theme_font_url` filter. Please be aware of licensing restrictions. If you're using a font from a forge and don't have permission to host the files directly or have restrictions about only making them available to certain domains, you will need to use another mechanism for hosting your fonts. Any font uploaded as part of a Dugway bundle will essentialy be publicly available and not CORS-restricted to specific domains.
 
-    {{ 'myfont.woff' | theme_font_url }}
+```
+{{ 'myfont.woff' | theme_font_url }}
+```
 
 ### Settings
 
@@ -124,7 +141,9 @@ Set your theme's name, version, and customizable options in the **settings.json*
 
 Run your theme in any browser by starting the Dugway server:
 
-    dugway server
+```
+dugway server
+```
 
 By default this will serve your theme at http://0.0.0.0:9292. You can then stop the server by hitting CTRL+C.
 
@@ -134,37 +153,45 @@ Tired of all the manual starting and stopping? Good news, Dugway is built on top
 
 ## Testing your theme
 
-Part of building a great theme is making sure it works well in a variety of contexts and with a variety of content. Dugway makes it easy to test your theme's versatility by customizing the **options** in the **config.ru** file.
+Part of building a great theme is making sure it works well in a variety of contexts and with a variety of content. Dugway makes it easy to test your theme's versatility by utilizing the **.dugway.json** file. This file will be specific to your computer for your own testing, and shouldn't be checked into source control.
 
-*Note:* changing the **config.ru** file will require you to restart the [server](#running-your-theme).
+*Note:* changing **.dugway.json** will require you to restart the [server](#running-your-theme).
 
 ### Store content
 
-The best way to see your theme under a different light is by previewing it with a different store's products, categories, pages, currency, and other content. To do this, simply set the **:store** option to any Big Cartel store's subdomain, and Dugway will bring in their content using the standard [Big Cartel API](http://help.bigcartel.com/developers/api/). By default we use **dugway** for [dugway.bigcartel.com](http://dugway.bigcartel.com).
+The best way to see your theme under a different light is by previewing it with a different store's products, categories, pages, currency, and other content. To do this, simply set the **store.subdomain** variable in **.dugway.json** to any Big Cartel store's subdomain, and Dugway will bring in their content using the standard [Big Cartel API](http://help.bigcartel.com/developers/api/). By default we use **dugway** for [dugway.bigcartel.com](http://dugway.bigcartel.com).
 
-    options[:store] = 'beeteeth'
+```json
+"store": {
+  "subdomain": "beeteeth"
+}
+```
 
 *Note:* don't worry, any sensitive data like inventory levels and discount codes is faked by Dugway.
 
 ### Store customization
 
-Another important thing to consider is how store owners will customize your theme. You establish what can be customized in your [settings.json](#settings) file, and Dugway allows you to simulate potential values people could choose by setting them in the **:customization** option. By default we use the **default** values from your **[settings.json](#settings)** file.
-
-    options[:customization] = {
-      :logo => {
-        :url => 'http://placehold.it/200x50/000000/ffffff&text=My+Logo',
-        :width => 200,
-        :height => 50
-      },
-      :background_color => '#CCCCCC',
-      :show_search => true,
-      :twitter_username => 'mytwitter'
-    }
+Another important thing to consider is how store owners will customize your theme. You establish what can be customized in your [settings.json](#settings) file, and Dugway allows you to simulate potential values people could choose by setting them in the **customization** variable in **.dugway.json**. By default we use the **default** values from your **[settings.json](#settings)** file.
+
+```json
+"customization": {
+  "logo": {
+    "url": "http://placehold.it/200x50/000000/ffffff&text=My+Logo",
+    "width": 200,
+    "height": 50
+  },
+  "background_color": "#CCCCCC",
+  "show_search": true,
+  "twitter_username": "bigcartel"
+}
+```
 
 ## Building your theme
 
 When you're finished with a new version of your theme, it's time to build it.
 
-    dugway build
+```
+dugway build
+```
 
 This will create a zip file for the current version in your **build** directory containing all HTML, images, fonts, and packaged JS and CSS.

data/lib/dugway.rb

@@ -48,7 +48,7 @@ module Dugway
     end
 
     def store
-      @store ||= Store.new(options && options[:store] || 'dugway')
+      @store ||= Store.new(options && options[:store] && options[:store][:subdomain] || 'dugway')
     end
 
     def theme

data/lib/dugway/cli/create.rb

@@ -26,6 +26,7 @@ module Dugway
 
       def core
         template('config.tt', "#{ @theme_dir }/config.ru")
+        template('dugway.tt', "#{ @theme_dir }/.dugway.json")
         template('source/settings.json', "#{ source_dir }/settings.json")
       end
 

data/lib/dugway/cli/templates/config.tt

@@ -1,22 +1,12 @@
 require 'dugway'
 
-options = {}
-
-# Use data from any store to make sure your theme looks great with all sorts of products, pages,
-# categories, and more. Just give us the subdomain. Default is "dugway" for dugway.bigcartel.com.
-# options[:store] = 'mystore'
-
-# Simulate the customization done by store owners by passing values to different variables.
-# Default values are based on the "default" for each setting in your settings.json.
-# options[:customization] = {
-#   :logo => {
-#     :url => 'http://placehold.it/200x50/000000/ffffff&text=My+Logo',
-#     :width => 200,
-#     :height => 50
-#   },
-#   :background_color => '#CCCCCC',
-#   :show_search => true,
-#   :twitter_username => 'mytwitter'
-# }
+begin
+  file = File.read('.dugway.json')
+  json = JSON.parse(file)
+  options = HashWithIndifferentAccess.new(json)
+rescue Exception => e
+  puts e
+  options = {}
+end
 
 run Dugway.application(options)

data/lib/dugway/cli/templates/dugway.tt

@@ -0,0 +1,27 @@
+// Use this file to test your theme with different stores and customization variations.
+// Learn more at: // https://github.com/bigcartel/dugway#testing-your-theme
+// DON'T CHECK THIS FILE INTO SOURCE CONTROL
+
+{
+
+  // Use data from any store to make sure your theme looks great with all sorts of products, pages,
+  // categories, and more. Just give us the subdomain. Default is "dugway" for dugway.bigcartel.com.
+
+  // "store": {
+  //   "subdomain": "mystore"
+  // },
+
+  // Simulate the customization done by store owners by passing values to different variables.
+  // Default values are based on the "default" for each setting in your settings.json.
+
+  // "customization": {
+  //   "logo": {
+  //     "url": "http://placehold.it/200x50/000000/ffffff&text=My+Logo",
+  //     "width": 200,
+  //     "height": 50
+  //   },
+  //   "background_color": "#CCCCCC",
+  //   "show_search": true,
+  //   "twitter_username": "bigcartel"
+  // }
+}

data/lib/dugway/cli/templates/gitignore.tt

@@ -1,6 +1,7 @@
 .bundle
 .DS_Store
 .sass-cache
+.dugway.json
 
 build
 tmp

data/lib/dugway/version.rb

@@ -1,3 +1,3 @@
 module Dugway
-  VERSION = "0.10.2"
+  VERSION = "0.10.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dugway
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Big Cartel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -415,6 +415,7 @@ files:
 - lib/dugway/cli/create.rb
 - lib/dugway/cli/server.rb
 - lib/dugway/cli/templates/config.tt
+- lib/dugway/cli/templates/dugway.tt
 - lib/dugway/cli/templates/gitignore.tt
 - lib/dugway/cli/templates/source/cart.html
 - lib/dugway/cli/templates/source/checkout.html