potatochop 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.1.0"
+  - "1.9.3"
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.0.2
+* [Add command line arguments so Potatochop can be configured at start time](https://github.com/VersaHQ/potatochop/pull/2/commits)
+* [Add an interface to Github so files can be served from a GH repo](https://github.com/VersaHQ/potatochop/commit/611b448973f53f6f38d889683e0e879d45b3ff2e)
+* Loads of file re-organization
+
+## 0.0.1
+* Initial release

data/README.md

@@ -1,20 +1,14 @@
 # Potatochop
+_A simple server for HAML & SASS mock ups_
 
-Impetus: [Because F$%k Photoshop](http://2012.jsconf.eu/speaker/2012/08/29/because-f-k-photoshop.html)
+[![Build Status](https://travis-ci.org/VersaHQ/potatochop.svg?branch=master)](https://travis-ci.org/VersaHQ/potatochop)
+[![Gem Version](https://badge.fury.io/rb/potatochop.svg)](http://badge.fury.io/rb/potatochop)
 
-## Installation
-
-Install Potatochop as a gem in the usual ways:
-
-Add this line to your application's Gemfile:
-
-    gem 'potatochop'
+[VersaHQ blog post on Potatochop](http://blog.versahq.com/post/82290792427/potatochop)
 
-And then execute:
-
-    $ bundle
+## Installation
 
-Or install it yourself as:
+Install Potatochop as a gem in the usual way:
 
     $ gem install potatochop
 
@@ -26,17 +20,62 @@ To use Potatochop, you also need a folder where you keep your mock ups. Ideally
 Once the Potatochop gem is installed, cd into your comps directory and run `potatochop`.
 
 ```
-$ cd comps_repo
+$ cd ~/mock_ups # or wherever you keep your mock_ups
 $ potatochop
 ```
+or pass in the path to your mock ups folder with the `--mockups` flag
 
-This will start up the Potatochop server on port 4567. By default, Potatochop will serve files in the same heirarchy as the mock ups folder.
+```
+$ potatochop --mockups ~/mock_ups
+```
+
+This will start up the Potatochop server on port 4567. By default, Potatochop will serve files in the same hierarchy as the mock ups folder.
+
+For example, if you start Potatochop in a folder with a file called `new_homepage.html.haml` you can see it in your browser at `http://localhost:4567/new_homepage.html`
 
 ## The Mock Ups folder
 
 For lack of a better name, the folder where you store your haml, sass, js, etc. files is called the mock ups folder.
 
-With the default configuration, Potatochop processes and serves any haml or sass file in this folder. Html & javascript files are served directly.
+Out of the box, Potatochop processes and serves any haml or sass file in this folder. Vanilla HTML & JavaScript files are served directly. For example, your mock ups folder could be organized like this:
+
+```
+~/mock_ups
+	about.html
+	faq.html.haml
+	index.html.haml
+	css/
+		about.css
+		faq.css.scss
+		index.css.scss
+	js/
+		interactions.js
+```
+
+**ProTip:** There is an example mock ups folder in the [spec/fake_mockups](https://github.com/VersaHQ/potatochop/tree/master/spec/fake_mockups) folder (it's used by our automated tests).
+
+When you want to include stylesheets in your haml/html pages, refer to them only by their `.css` extension. Using the above folder layout:
+
+```
+ # index.html.haml
+ %link{ rel: 'stylesheet', href: 'css/index.css' }
+```
+## Serving files from a GitHub repo
+Let's say you have a repository on GitHub where you keep your mockups (i.e [https://github.com/mertonium/potatochop_comps](https://github.com/mertonium/potatochop_comps)).
+
+You can serve this repo by passing `potatochop` the `--interface` flag along with the repo path:
+
+```
+# Serve files from a public repository on GitHub
+$ potatochop --interface github --repo mertonium/potatochop_comps
+```
+If your mock ups folder is in a private repo, you must also pass `potatochop` the `--token` flag, along with a [personal access token](https://github.com/settings/tokens/new):
+
+```
+# Serve files from a private repository on GitHub
+$ potatochop --interface github --repo mertonium/potatochop_comps_private --token=GITHUB_ACCESS_TOKEN
+```
+
 
 ## Contributing
 

data/bin/potatochop

@@ -2,5 +2,4 @@
 
 require 'potatochop'
 
-wd = ARGV[0] || '.'
-Potatochop::Web.run!(:working_dir => wd)
+Potatochop.start_up(ARGV)

data/lib/potatochop/cli_parser.rb

@@ -0,0 +1,43 @@
+require 'optparse'
+
+module Potatochop
+  class CliParser
+    def self.parse(args)
+      options = {
+        :interface => nil,
+        :interface_class => Potatochop::FileSystemInterface,
+        :mockups_path => '.',
+        :gh_options => {}
+      }
+    
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: potatochop [options]"
+      
+        opts.separator ""
+        opts.separator "Specific options:"
+      
+        opts.on("-i", "--interface [INTERFACE]", "How to find the files to serve (possible options are 'local' and 'github')") do |interface|
+          if interface == 'github'
+            options[:interface_class] = Potatochop::GithubInterface
+          end
+        end
+
+        opts.on("-d", "--mockups [PATH]", "Path to the mockups folder you want to serve") do |wd|
+          options[:mockups_path] = wd
+        end
+      
+        opts.on("--repo [GITHUB REPOSITORY]", "username/reponame on GitHub") do |repo|
+          options[:mockups_path] = repo
+        end
+      
+        opts.on("--token [GITHUB ACCESS TOKEN]", "GitHub access token (needed to access private repositories)") do |token|
+          options[:gh_options][:access_token] = token
+        end
+      end
+    
+      opts.parse!(args)
+      options[:interface] = options[:interface_class].send(:new, options[:mockups_path], options[:gh_options])
+      options
+    end
+  end
+end

data/lib/potatochop/file_system_interface.rb

@@ -0,0 +1,19 @@
+module Potatochop
+  class FileSystemInterface
+    attr_reader :source
+
+    def initialize(source, options = {})
+      @source = source
+    end
+    
+    def exists?(file_name)
+      file_path = File.join(@source, file_name)
+      File.exists? file_path
+    end
+    
+    def read(file_name)
+      file_path = File.join(@source, file_name)
+      File.read(file_path)
+    end
+  end
+end

data/lib/potatochop/github_interface.rb

@@ -0,0 +1,23 @@
+module Potatochop
+  class GithubInterface
+    attr_reader :source
+
+    def initialize(repo, gh_options = {})
+      @source = repo
+      @gh_client = Octokit::Client.new access_token: gh_options[:access_token]
+    end
+    
+    def exists?(file_name)
+      begin
+        @gh_client.contents(@source, path: file_name, accept: 'application/vnd.github.raw')
+        true
+      rescue Octokit::NotFound
+        false
+      end
+    end
+    
+    def read(file_name)
+      @gh_client.contents(@source, path: file_name, accept: 'application/vnd.github.raw')
+    end
+  end
+end

data/lib/potatochop/spud.rb

@@ -0,0 +1,27 @@
+module Potatochop
+  class Spud
+    def initialize(interface)
+      @interface = interface
+    end
+    
+    def get_file(file_name)
+      @interface.exists?(file_name) ? @interface.read(file_name) : nil
+    end
+    
+    def get_html(file_name)
+      if @interface.exists?("#{file_name}.html") # Static html first
+        @interface.read("#{file_name}.html")
+      elsif @interface.exists?("#{file_name}.html.haml") # Haml next
+        Haml::Engine.new(@interface.read("#{file_name}.html.haml")).render
+      end
+    end
+    
+    def get_css(file_name)
+      if @interface.exists?("#{file_name}.css")  # Static css
+        @interface.read("#{file_name}.css")
+      elsif @interface.exists?("#{file_name}.css.scss") # Sass css
+        Sass::Engine.new(@interface.read("#{file_name}.css.scss"), :syntax => :scss).render
+      end
+    end
+  end
+end

data/lib/potatochop/version.rb

@@ -1,3 +1,3 @@
 module Potatochop
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/potatochop/web.rb

@@ -0,0 +1,36 @@
+require 'sinatra/base'
+
+module Potatochop
+  class Web < Sinatra::Base
+    get '/*.html' do
+      return_str = settings.tater.get_html(params[:splat][0])
+      return_str.nil? ? 404 : return_str
+    end
+
+    get '/*.css' do
+      return_str = settings.tater.get_css(params[:splat][0])
+      content_type 'text/css', :charset => 'utf-8'
+      return_str.nil? ? 404 : return_str
+    end
+
+    get %r{/(.*).(png|jpg|jpeg|gif)} do
+      image_file = settings.tater.get_file("#{params[:captures][0]}.#{params[:captures][1]}")
+      if image_file.nil?
+        404
+      else
+        content_type "image/#{params[:captures].last}"
+        image_file
+      end
+    end
+
+    get '/*.js' do
+      js_file = settings.tater.get_file("#{params[:splat][0]}.js")
+      if js_file.nil?
+        404
+      else
+        content_type "application/javascript", :charset => 'utf-8'
+        js_file
+      end
+    end
+  end
+end

data/lib/potatochop.rb

@@ -1,52 +1,16 @@
 require 'potatochop/version'
-require 'sinatra/base'
+require 'potatochop/spud'
+require 'potatochop/file_system_interface'
+require 'potatochop/github_interface'
+require 'potatochop/cli_parser'
+require 'potatochop/web'
 require 'haml'
 require 'sass'
+require 'octokit'
 
 module Potatochop
-  class Web < Sinatra::Base
-    get '/*.html' do
-      file_path = File.join(settings.working_dir, "#{params[:splat][0]}.html")
-      # Static html first
-      if File.exists? file_path
-        send_file file_path
-      # Haml next
-      elsif File.exists? file_path + ".haml"
-        Haml::Engine.new(File.read("#{file_path}.haml")).render
-      else
-        404
-      end
-    end
-    
-    get '/*.css' do
-      file_path = File.join(settings.working_dir, "#{params[:splat][0]}.css")
-      if File.exists? file_path
-        content_type 'text/css', :charset => 'utf-8'
-        send_file file_path
-      elsif File.exists? file_path + '.scss'
-        content_type 'text/css', :charset => 'utf-8'
-        Sass::Engine.new(File.read("#{file_path}.scss"), :syntax => :scss).render
-      else
-        404
-      end
-    end
-    
-    get %r{/(.*).(png|jpg|jpeg|gif)} do
-      file_path = File.join(settings.working_dir, "#{params[:captures][0]}.#{params[:captures][1]}")
-      if File.exists? file_path
-        send_file file_path
-      else
-        404
-      end
-    end
-    
-    get '/*.js' do
-      file_path = File.join(settings.working_dir, "#{params[:splat][0]}.js")
-      if File.exists? file_path
-        send_file file_path
-      else
-        404
-      end
-    end
+  def self.start_up(args)
+    options = Potatochop::CliParser.parse(args)
+    Potatochop::Web.run!(:tater => Potatochop::Spud.new(options[:interface]))
   end
 end

data/potatochop.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'thin'
   gem.add_runtime_dependency 'haml'
   gem.add_runtime_dependency 'sass'
+  gem.add_runtime_dependency 'octokit'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'simplecov'

data/spec/file_system_interface_spec.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+describe Potatochop::FileSystemInterface do
+  describe '#new' do
+    it 'creates a new FileSystemInterface object with the proper source' do
+      fs = Potatochop::FileSystemInterface.new('spec/fake_mockups')
+      fs.source.should == "spec/fake_mockups"
+    end
+  end
+  describe '#exists?' do
+    it 'returns true if the given file exists' do
+      fs = Potatochop::FileSystemInterface.new('spec/fake_mockups')
+      fs.exists?('foo.html.haml').should be_true
+    end
+    
+    it 'returns false if the given file does not exist' do
+      fs = Potatochop::FileSystemInterface.new('spec/fake_mockups')
+      fs.exists?('not_real.html').should be_false
+    end
+  end
+  
+  describe '#read' do
+    it 'returns the content of the given files' do
+      fs = Potatochop::FileSystemInterface.new('spec/fake_mockups')
+      fs.read('foo.html.haml').should == File.read('spec/fake_mockups/foo.html.haml')
+    end
+    
+    it 'returns false if the given file does not exist' do
+      fs = Potatochop::FileSystemInterface.new('spec/fake_mockups')
+      expect { fs.read('not_real.html') }.to raise_error
+    end
+  end
+end

data/spec/potatochop_spec.rb

@@ -6,7 +6,7 @@ end
 
 describe 'Potatochop' do
   describe 'Web' do
-    app.set('working_dir','/Users/mertonium/Code/potatochop/spec/fake_site')
+    app.set(:tater => Potatochop::Spud.new(Potatochop::FileSystemInterface.new('spec/fake_mockups')))
     include Rack::Test::Methods
 
     it 'returns an error when a haml page does not exist' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: potatochop
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -149,20 +165,28 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/potatochop
 - lib/potatochop.rb
+- lib/potatochop/cli_parser.rb
+- lib/potatochop/file_system_interface.rb
+- lib/potatochop/github_interface.rb
+- lib/potatochop/spud.rb
 - lib/potatochop/version.rb
+- lib/potatochop/web.rb
 - potatochop.gemspec
-- spec/fake_site/bar.html
-- spec/fake_site/css/bar.css
-- spec/fake_site/css/foo.css.scss
-- spec/fake_site/foo.html.haml
-- spec/fake_site/img/potatochop_cs4_box.png
-- spec/fake_site/js/bar.js
+- spec/fake_mockups/bar.html
+- spec/fake_mockups/css/bar.css
+- spec/fake_mockups/css/foo.css.scss
+- spec/fake_mockups/foo.html.haml
+- spec/fake_mockups/img/potatochop_cs4_box.png
+- spec/fake_mockups/js/bar.js
+- spec/file_system_interface_spec.rb
 - spec/helper.rb
 - spec/potatochop_spec.rb
 homepage: https://github.com/VersaHQ/potatochop
@@ -191,11 +215,12 @@ specification_version: 3
 summary: Potatochop is a simple server that compiles and serves up HAML and SASS files.
   The goal is to reduce friction between designers and devs in a Rails project.
 test_files:
-- spec/fake_site/bar.html
-- spec/fake_site/css/bar.css
-- spec/fake_site/css/foo.css.scss
-- spec/fake_site/foo.html.haml
-- spec/fake_site/img/potatochop_cs4_box.png
-- spec/fake_site/js/bar.js
+- spec/fake_mockups/bar.html
+- spec/fake_mockups/css/bar.css
+- spec/fake_mockups/css/foo.css.scss
+- spec/fake_mockups/foo.html.haml
+- spec/fake_mockups/img/potatochop_cs4_box.png
+- spec/fake_mockups/js/bar.js
+- spec/file_system_interface_spec.rb
 - spec/helper.rb
 - spec/potatochop_spec.rb