slicecraft 0.1.0

data/README.md

@@ -0,0 +1,25 @@
+# SliceCraft
+
+SliceCraft commands for generating, previewing and delivering a project.
+
+Download the latest gemfile in the [downloads](https://github.com/80beans/slicecraft/downloads) section, then run `gem install /.[gemfile name]` in your console to install the gem.
+
+## Commands
+
+````
+slicecraft new [projectname]
+````
+
+Creates a new project folder with middleman template in your current folder.
+
+````
+slicecraft preview
+````
+
+Run this in your project folder to create a preview and upload it to the server.
+
+````
+slicecraft deliver
+````
+
+Run this in your project folder to deliver the project, a zip of the build and source is uploaded to the server.

data/bin/slicecraft

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/slicecraft')
+
+program :version, '0.0.1'
+program :description, "The 80beans SliceCraft gem. Run 'slicecraft new [projectname]' to create a new SliceCraft project."
+
+command :new do |c|
+  c.syntax = 'slicecraft new [projectname]'
+  c.summary = 'Initialize a new project.'
+  c.description = 'Enter a project name to create a folder with that name and generate the 80beans middleman template.'
+  c.action do |args, options|
+    if args.first
+      c.when_called Slicecraft::Project.create(:directory => args.first)
+      say "Project '#{args.first}' successfully created, have fun slicing!"
+    else
+      say "Error: Enter a projectname (slicecraft new [projectname])"
+    end
+  end
+end
+
+command :preview do |c|
+  c.syntax = 'slicecraft preview'
+  c.summary = 'Ships the project to the preview server'
+  c.description = 'When in a folder containing a middleman project run this to sync a preview to the server.'
+  c.option '--url', String, 'Instead of building the preview this only shows the preview url'
+  c.action do |args, options|
+    if options.url
+      say "Preview url: #{Slicecraft::Preview.new(:directory => Dir.pwd).result_url}"
+    else
+      c.when_called Slicecraft::Project.build
+      preview = Slicecraft::Preview.new(:directory => Dir.pwd)
+      preview.process
+      say "Shipped to: #{preview.result_url}"
+      say "Pages:"
+      preview.result_urls.each{ |r| say r }
+    end
+  end
+end
+
+command :deliver do |c|
+  c.syntax = 'slicecraft deliver'
+  c.summary = 'Delivers a project zip'
+  c.description = 'When in a folder containing a middleman project run this to deliver a project zip containing the build and source to the server.'
+  c.option '--url', String, 'Instead of delivering the zip this only shows the zip url'
+  c.action do |args, options|
+    if options.url
+      say "Zip url: #{Slicecraft::Delivery.new(:directory => Dir.pwd).result_url}"
+    else
+      c.when_called Slicecraft::Project.build
+      delivery = Slicecraft::Delivery.new(:directory => Dir.pwd)
+      delivery.process
+      say "Zipped to: #{delivery.result_url}"
+    end
+  end
+end

data/config.yml

@@ -0,0 +1,7 @@
+server:
+  url: slicecraft.nl
+  user: slicecraft
+  preview_path: /home/slicecraft/previews/
+  result_url: http://preview.slicecraft.nl
+
+template_repo: git@github.com:80beans/slicecraft_template.git

data/lib/slicecraft.rb

@@ -0,0 +1,117 @@
+require 'net/scp'
+require 'yaml'
+require 'zip/zip'
+
+module Slicecraft
+
+  class Project
+
+    def self.create(options)
+      @location = options[:directory]
+
+      system "git clone #{self.template_repo} #{@location}"
+      FileUtils.rm_rf "#{@location}/.git"
+    end
+
+    def self.build
+      result = system "middleman build"
+      raise 'Middleman could not build' unless result
+    end
+
+    def self.template_repo
+      YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__), '../config.yml')))['template_repo']
+    end
+
+  end
+
+  class Syncer
+    attr_accessor :path
+    attr_accessor :settings
+
+    def initialize(options)
+      @path = options[:directory]
+    end
+
+    def hashed_path
+      "#{project_name}_#{Digest::SHA1.hexdigest('12RThh' + project_name)}"
+    end
+
+    def result_url
+      "#{settings['result_url']}/#{hashed_path}"
+    end
+
+    def project_name
+      @path.split('/').last
+    end
+
+    def build_path
+      "#{@path}/build/"
+    end
+
+    def settings
+      @settings ||= YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__), '../config.yml')))['server']
+    end
+
+  end
+
+
+  class Preview < Syncer
+
+    def result_urls
+      results = Dir.entries(build_path).select{ |file| file.end_with?('.html') }.map{ |r| "#{result_url}/#{r}" }
+      FileUtils.rm_rf build_path if File.exists? build_path
+      results
+    end
+
+    def process
+      system "rsync -ave ssh #{build_path} #{settings['user']}@#{settings['url']}:#{"#{settings['preview_path']}#{hashed_path}"}"
+    end
+
+  end
+
+  class Delivery < Syncer
+
+    def process
+      zip
+      sync
+    end
+
+    def zip
+      if File.exists?('zip/source.zip')
+        File.delete('zip/source.zip')
+      else
+        FileUtils.mkdir('zip') unless File.exists?('zip')
+      end
+      Zip::ZipFile.open(File.join(zip_path, 'source.zip'), Zip::ZipFile::CREATE) do |zipfile|
+        add_folder_to_zipfile(zipfile, 'source')
+        add_folder_to_zipfile(zipfile, 'build')
+      end
+    end
+
+    def add_folder_to_zipfile(zipfile, folder)
+      Dir["#{path}/#{folder}/**/**"].each do |file|
+        zipfile.add(file.sub(path+'/',''),file)
+      end
+    end
+
+    def zip_path
+      "#{@path}/zip/"
+    end
+
+    def result_url
+      super + '/source.zip'
+    end
+
+    def hashed_path
+      super + '/zip'
+    end
+
+    def sync
+      system "rsync -ave ssh #{zip_path} #{settings['user']}@#{settings['url']}:#{"#{settings['preview_path']}#{hashed_path}"}"
+      FileUtils.rm_rf zip_path if File.exists? zip_path
+      FileUtils.rm_rf build_path if File.exists? build_path
+    end
+
+  end
+
+end

data/spec/lib/slicecraft_spec.rb

@@ -0,0 +1,161 @@
+require 'rspec'
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/slicecraft')
+
+describe Slicecraft::Project do
+
+  context ".create" do
+
+    it "should create a project" do
+      Slicecraft::Project.should_receive(:system).with("git clone git@github.com:80beans/slicecraft_template.git /slice_this")
+      FileUtils.should_receive(:rm_rf).with("/slice_this/.git")
+
+      Slicecraft::Project.create(:directory => "/slice_this")
+    end
+
+  end
+
+  context ".build" do
+
+    it "should build a project" do
+      Slicecraft::Project.should_receive(:system).with("middleman build").and_return(true)
+
+      Slicecraft::Project.build
+    end
+
+  end
+
+end
+
+describe Slicecraft::Syncer do
+
+  let(:syncer) { Slicecraft::Syncer.new(:directory => '/slice_this') }
+
+  context "#settings" do
+
+    it "should have settings" do
+      syncer.settings.should == {
+        "url" => "slicecraft.nl",
+        "user" => "slicecraft",
+        "preview_path" => "/home/slicecraft/previews/",
+        "result_url" => "http://preview.slicecraft.nl"
+      }
+    end
+
+  end
+
+  context "#project_name" do
+
+    it "project_name should be current folder name" do
+      syncer.project_name.should == 'slice_this'
+    end
+
+    context "with longer path" do
+
+      let(:syncer) { Slicecraft::Syncer.new(:directory => '/this/path/is/long/slice_this') }
+
+      it "project_name should be current folder name" do
+        syncer.project_name.should == 'slice_this'
+      end
+
+    end
+
+  end
+
+  context "#hashed_path" do
+
+    it "should return a path with an id hash in it" do
+      syncer.hashed_path.should == 'slice_this_240999fa70d7f05b158bd1170ff932ac0503bea2'
+    end
+
+  end
+
+  context "#result_url" do
+
+    it "should return the correct result_url" do
+      syncer.result_url.should == "http://preview.slicecraft.nl/slice_this_240999fa70d7f05b158bd1170ff932ac0503bea2"
+    end
+
+  end
+
+end
+
+describe Slicecraft::Preview do
+
+  let(:preview) { Slicecraft::Preview.new(:directory => '/slice_this') }
+
+  context "#build_path" do
+
+    it "should return the build path" do
+      preview.build_path.should == '/slice_this/build/'
+    end
+
+  end
+
+  context "#process" do
+
+    it "should process the preview" do
+      preview.should_receive(:system).
+        with("rsync -ave ssh /slice_this/build/ slicecraft@slicecraft.nl:/home/slicecraft/previews/slice_this_240999fa70d7f05b158bd1170ff932ac0503bea2")
+
+      preview.process
+    end
+
+  end
+
+end
+
+describe Slicecraft::Delivery do
+
+  let(:delivery) { Slicecraft::Delivery.new(:directory => '/slice_this') }
+
+  context "#zip_path" do
+
+    it "should return the zip path" do
+      delivery.zip_path.should == '/slice_this/zip/'
+    end
+
+  end
+
+  context "#sync" do
+
+    it "should sync the zip" do
+      delivery.should_receive(:system).
+        with("rsync -ave ssh /slice_this/zip/ slicecraft@slicecraft.nl:/home/slicecraft/previews/slice_this_240999fa70d7f05b158bd1170ff932ac0503bea2/zip")
+
+      delivery.sync
+    end
+
+  end
+
+  context "#zip" do
+
+    it "should create zip folder and file" do
+      Zip::ZipFile.should_receive('open')
+      FileUtils.should_receive('mkdir').with('zip')
+
+      delivery.zip
+    end
+
+    context "with existing zip file" do
+
+      before do
+        FileUtils.mkdir('zip')
+        FileUtils.touch('zip/source.zip')
+      end
+
+      it "should delete the zip folder and file when a zip file exists" do
+        Zip::ZipFile.should_receive('open')
+        File.should_receive('delete').with('zip/source.zip')
+
+        delivery.zip
+      end
+
+      after do
+        FileUtils.rm_rf('zip')
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: slicecraft
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ron Cadier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A commandline tool specific for the SliceCraft project flow
+email: ron@80beans.com
+executables:
+- slicecraft
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/slicecraft.rb
+- spec/lib/slicecraft_spec.rb
+- bin/slicecraft
+- README.md
+- config.yml
+homepage: http://80beans.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Internal tool for SliceCraft
+test_files: []