furoshiki 0.0.2 → 0.1.0

data/lib/furoshiki/zip/recursive.rb

@@ -0,0 +1,58 @@
+require 'pathname'
+require 'zip/zip'
+
+module Furoshiki
+  module Zip
+    # Adapted from rubyzip's sample, ZipFileGenerator
+    #
+    # This is a utility class that uses rubyzip to recursively
+    # generate a zip file containing the given entries and all of
+    # their children.
+    #
+    # Best used through frontend classes Furoshiki::Zip::Directory or
+    # Furoshiki::Zip::DirectoryContents
+    #
+    # @example
+    # To zip the directory "/tmp/input" so that unarchiving
+    # gives you a single directory "input":
+    # 
+    #   zip = Furoshiki::Zip::Recursive
+    #   entries = Pathname.new("/tmp/input").entries
+    #   zip_prefix = ''
+    #   disk_prefix = '/tmp'
+    #   output_file = '/tmp/out.zip'
+    #   zf.write(entries, disk_prefix, zip_prefix, output_file)
+    class Recursive
+      def initialize(output_file)
+        @output_file = output_file.to_s
+      end
+
+      # @param [Array<Pathname>] entries the initial set of files to include
+      # @param [Pathname] disk_prefix a path prefix for existing entries
+      # @param [Pathname] zip_prefix a path prefix to add within archive
+      # @param [Pathname] output_file the location of the output archive
+      def write(entries, disk_prefix, zip_prefix)
+        io = ::Zip::ZipFile.open(@output_file, ::Zip::ZipFile::CREATE); 
+        write_entries(entries, disk_prefix, zip_prefix, io)
+        io.close();
+      end
+
+      # A helper method to make the recursion work.
+      private
+      def write_entries(entries, disk_prefix, path, io)
+        entries.each do |e|
+          zip_path = path.to_s == "" ? e.basename : path.join(e.basename)
+          disk_path = disk_prefix.join(zip_path)
+          puts "Deflating #{disk_path}"
+          if disk_path.directory?
+            io.mkdir(zip_path)
+            subdir = disk_path.children(false)
+            write_entries(subdir, disk_prefix, zip_path, io)
+          else
+            io.get_output_stream(zip_path) { |f| f.puts(File.open(disk_path, "rb").read())}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/furoshiki/zip.rb

@@ -0,0 +1,2 @@
+require 'furoshiki/zip/directory'
+require 'furoshiki/zip/directory_contents'

data/lib/furoshiki.rb

@@ -1 +1,3 @@
-require_relative 'furoshiki/rake_task'
+puts "OMG, nothing here!"
+puts ""
+puts "You probably want to `require 'furoshiki/shoes'`.

data/lib/warbler/traits/shoes.rb

@@ -0,0 +1,51 @@
+require 'furoshiki/shoes/configuration'
+
+module Warbler
+  module Traits
+    # Hack to control the executable
+    class NoGemspec
+      def update_archive(jar); end
+    end
+
+    class Shoes
+      include Trait
+      include PathmapHelper
+
+      def self.detect?
+        #File.exist? "app.yaml"
+        true
+      end
+
+      def self.requires?(trait)
+        # Actually, it would be better to dump the NoGemspec trait, but since
+        # we can't do that, we can at least make sure that this trait gets
+        # processed later by declaring that it requires NoGemspec.
+        [Traits::Jar, Traits::NoGemspec].include? trait
+      end
+
+      def after_configure
+        config.init_contents << StringIO.new("require 'shoes'\nShoes.configuration.backend = :swt\n")
+      end
+
+      def update_archive(jar)
+        # Not sure why Warbler doesn't do this automatically
+        jar.files.delete_if { |k, v| @config.excludes.include? k }
+        add_main_rb(jar, apply_pathmaps(config, default_executable, :application))
+      end
+
+      # Uses the `@config.run` if it exists. Otherwise, looks in the
+      # application's `bin` directory for an executable with the same name as
+      # the jar. If this also fails, defaults to the first executable (alphabetically) in the
+      # applications `bin` directory.
+      #
+      # @return [String] filename of the executable to run
+      def default_executable
+        return @config.run if @config.run
+        exes = Dir['bin/*'].sort
+        exe = exes.grep(/#{config.jar_name}/).first || exes.first
+        raise "No executable script found" unless exe
+        exe
+      end
+    end
+  end
+end

data/spec/shoes/configuration_spec.rb

@@ -0,0 +1,156 @@
+require_relative 'spec_helper'
+require 'furoshiki/shoes/configuration'
+
+describe Furoshiki::Shoes::Configuration do
+  context "defaults" do
+    subject { Furoshiki::Shoes::Configuration.new }
+
+    its(:name) { should eq('Shoes App') }
+    its(:shortname) { should eq('shoesapp') }
+    its(:ignore) { should eq(['pkg']) }
+    its(:gems) { should include('shoes') }
+    its(:version) { should eq('0.0.0') }
+    its(:release) { should eq('Rookie') }
+    its(:icons) { should be_an_instance_of(Hash) }
+    its(:dmg) { should be_an_instance_of(Hash) }
+    its(:run) { should be_nil }
+
+    describe "#icon" do
+      it 'osx is nil' do
+        subject.icons[:osx].should be_nil
+      end
+
+      it 'gtk is nil' do
+        subject.icons[:gtk].should be_nil
+      end
+
+      it 'win32 is nil' do
+        subject.icons[:win32].should be_nil
+      end
+    end
+
+    describe "#dmg" do
+      it "has ds_store" do
+        subject.dmg[:ds_store].should eq('path/to/default/.DS_Store')
+      end
+
+      it "has background" do
+        subject.dmg[:background].should eq('path/to/default/background.png')
+      end
+    end
+
+    describe "#to_hash" do
+      it "round-trips" do
+        Furoshiki::Shoes::Configuration.new(subject.to_hash).should eq(subject)
+      end
+    end
+  end
+
+  context "with options" do
+    include_context 'config'
+    subject { Furoshiki::Shoes::Configuration.load(config_filename) }
+
+    its(:name) { should eq('Sugar Clouds') }
+    its(:shortname) { should eq('sweet-nebulae') }
+    its(:ignore) { should include('pkg') }
+    its(:gems) { should include('rspec') }
+    its(:gems) { should include('shoes') }
+    its(:version) { should eq('0.0.1') }
+    its(:release) { should eq('Mindfully') }
+    its(:icons) { should be_an_instance_of(Hash) }
+    its(:dmg) { should be_an_instance_of(Hash) }
+
+    describe "#icon" do
+      it 'has osx' do
+        subject.icons[:osx].should eq('img/boots.icns')
+      end
+
+      it 'has gtk' do
+        subject.icons[:gtk].should eq('img/boots_512x512x32.png')
+      end
+
+      it 'has win32' do
+        subject.icons[:win32].should eq('img/boots.ico')
+      end
+    end
+
+    describe "#dmg" do
+      it "has ds_store" do
+        subject.dmg[:ds_store].should eq('path/to/custom/.DS_Store')
+      end
+
+      it "has background" do
+        subject.dmg[:background].should eq('path/to/custom/background.png')
+      end
+    end
+
+    it "incorporates custom features" do
+      subject.custom.should eq('my custom feature')
+    end
+  end
+
+  context "with name, but without explicit shortname" do
+    let(:options) { {:name => "Sugar Clouds"} }
+    subject { Furoshiki::Shoes::Configuration.new options }
+
+    its(:name) { should eq("Sugar Clouds") }
+    its(:shortname) { should eq("sugarclouds") }
+  end
+
+  context "auto-loading" do
+    include_context 'config'
+
+    context "without a path" do
+      it "looks for 'app.yaml' in current directory" do
+        Dir.chdir config_filename.parent do
+          config = Furoshiki::Shoes::Configuration.load
+          config.shortname.should eq('sweet-nebulae')
+        end
+      end
+
+      it "blows up if it can't find the file" do
+        Dir.chdir File.dirname(__FILE__) do
+          lambda { config = Furoshiki::Shoes::Configuration.load }.should raise_error
+        end
+      end
+    end
+
+    shared_examples "config with path" do
+      it "finds the config" do
+        Dir.chdir File.dirname(__FILE__) do
+          config = Furoshiki::Shoes::Configuration.load(path)
+          config.shortname.should eq('sweet-nebulae')
+        end
+      end
+    end
+
+    context "with an 'app.yaml'" do
+      let(:path) { config_filename }
+      it_behaves_like "config with path"
+    end
+
+    context "with a path to a directory containing an 'app.yaml'" do
+      let(:path) { config_filename.parent }
+      it_behaves_like "config with path"
+    end
+
+    context "with a path to a file that is siblings with an 'app.yaml'" do
+      let(:path) { config_filename.parent.join('sibling.rb') }
+      it_behaves_like "config with path"
+    end
+
+    context "with a path that exists, but no 'app.yaml'" do
+      let(:path) { config_filename.parent.join('bin/hello_world') }
+      subject { Furoshiki::Shoes::Configuration.load(path) }
+
+      its(:name) { should eq('hello_world') }
+      its(:shortname) { should eq('hello_world') }
+    end
+
+    context "when the file doesn't exist" do
+      it "blows up" do
+        lambda { Furoshiki::Shoes::Configuration.load('some/bogus/path') }.should raise_error
+      end
+    end
+  end
+end

data/spec/shoes/spec_helper.rb

@@ -0,0 +1,68 @@
+SHOESSPEC_ROOT = File.expand_path('..', __FILE__)
+
+# Packaging caches files in $HOME/.furoshiki/cache by default.
+# For testing, we override $HOME using $FUROSHIKI_HOME
+ENV['FUROSHIKI_HOME'] = SHOESSPEC_ROOT
+
+require 'rspec'
+require 'pathname'
+require 'furoshiki/shoes'
+
+# Guards for running or not running specs. Specs in the guarded block only
+# run if the guard conditions are met.
+#
+# @see Guard#backend_is
+module Guard
+  # Runs specs only if backend matches given name
+  #
+  # @example
+  # backend_is :swt do
+  #   specify "backend_name is :swt" do
+  #     # body of spec
+  #   end
+  # end
+  def backend_is(backend)
+    yield if Shoes.configuration.backend_name == backend && block_given?
+  end
+
+  # Runs specs only if platform matches
+  #
+  # @example
+  # platform_is :windows do
+  #   it "does something only on windows" do
+  #     # specification
+  #   end
+  # end
+  def platform_is(platform)
+    yield if self.send "platform_is_#{platform.to_s}"
+  end
+
+  # Runs specs only if platform does not match
+  #
+  # @example
+  # platform_is_not :windows do
+  #   it "does something only on posix systems" do
+  #     # specification
+  #   end
+  # end
+  def platform_is_not(platform)
+    yield unless self.send "platform_is_#{platform.to_s}"
+  end
+
+  def platform_is_windows
+    return RbConfig::CONFIG['host_os'] =~ /windows|mswin/i
+  end
+
+  def platform_is_linux
+    return RbConfig::CONFIG['host_os'] =~ /linux/i
+  end
+
+  def platform_is_osx
+    return RbConfig::CONFIG['host_os'] =~ /darwin/i
+  end
+end
+
+include Guard
+
+Dir["#{SHOESSPEC_ROOT}/support/**/*.rb"].each {|f| require f}
+

data/spec/shoes/support/shared_config.rb

@@ -0,0 +1,6 @@
+require 'yaml'
+require 'pathname'
+
+shared_context 'config' do
+  let(:config_filename) { Pathname.new(__FILE__).join('../../test_app/app.yaml').cleanpath }
+end

data/spec/shoes/swt_app_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+require_relative 'spec_helper'
+require 'pathname'
+require 'furoshiki/shoes/swt_app'
+
+include PackageHelpers
+
+describe Furoshiki::Shoes::SwtApp do
+  include_context 'config'
+  include_context 'package'
+
+  let(:app_name) { 'Sugar Clouds.app' }
+  let(:output_file) { output_dir.join app_name }
+  let(:config) { Furoshiki::Shoes::Configuration.load config_filename}
+  let(:launcher) { output_file.join('Contents/MacOS/JavaAppLauncher') }
+  let(:icon)  { output_file.join('Contents/Resources/boots.icns') }
+  let(:jar) { output_file.join('Contents/Java/sweet-nebulae.jar') }
+  subject { Furoshiki::Shoes::SwtApp.new config }
+
+  # $FUROSHIKI_HOME is set in spec_helper.rb for testing purposes,
+  # but should default to $HOME
+  context "when not setting $FUROSHIKI_HOME" do
+    before do
+      @old_furoshiki_home = ENV['FUROSHIKI_HOME']
+      ENV['FUROSHIKI_HOME'] = nil
+    end
+
+    its(:cache_dir) { should eq(Pathname.new(Dir.home).join('.furoshiki', 'cache')) }
+
+    after do
+      ENV['FUROSHIKI_HOME'] = @old_furoshiki_home
+    end
+  end
+
+  context "default" do
+    let(:cache_dir) { Pathname.new(SHOESSPEC_ROOT).join('.furoshiki', 'cache') }
+    its(:cache_dir) { should eq(cache_dir) }
+
+    it "sets package dir to {pwd}/pkg" do
+      Dir.chdir app_dir do
+        subject.default_package_dir.should eq(app_dir.join 'pkg')
+      end
+    end
+
+    its(:template_path) { should eq(cache_dir.join('shoes-app-template.zip')) }
+    its(:remote_template_url) { should eq('http://shoesrb.com/downloads/shoes-app-template-0.0.1.zip') }
+  end
+
+  context "when creating a .app" do
+    before :all do
+      output_dir.rmtree if output_dir.exist?
+      output_dir.mkpath
+      Dir.chdir app_dir do
+        subject.package
+      end
+    end
+
+    its(:template_path) { should exist }
+
+    it "creates a .app" do
+      output_file.should exist
+    end
+
+    it "includes launcher" do
+      launcher.should exist
+    end
+
+    # Windows can't test this
+    platform_is_not :windows do
+      it "makes launcher executable" do
+        launcher.should be_executable
+      end
+    end
+
+    it "deletes generic icon" do
+      icon.parent.join('GenericApp.icns').should_not exist 
+    end
+
+    it "injects icon" do
+      icon.should exist
+    end
+
+    it "injects jar" do
+      jar.should exist
+    end
+
+    it "removes any extraneous jars" do
+      jar_dir_contents = output_file.join("Contents/Java").children
+      jar_dir_contents.reject {|f| f == jar }.should be_empty
+    end
+
+    describe "Info.plist" do
+      require 'plist'
+      before :all do
+        @plist = Plist.parse_xml(output_file.join 'Contents/Info.plist')
+      end
+
+      it "sets identifier" do
+        @plist['CFBundleIdentifier'].should eq('com.hackety.shoes.sweet-nebulae')
+      end
+
+      it "sets display name" do
+        @plist['CFBundleDisplayName'].should eq('Sugar Clouds')
+      end
+
+      it "sets bundle name" do
+        @plist['CFBundleName'].should eq('Sugar Clouds')
+      end
+
+      it "sets icon" do
+        @plist['CFBundleIconFile'].should eq('boots.icns')
+      end
+
+      it "sets version" do
+        @plist['CFBundleVersion'].should eq('0.0.1')
+      end
+    end
+  end
+end

data/spec/shoes/swt_jar_spec.rb

@@ -0,0 +1,45 @@
+require_relative 'spec_helper'
+require 'pathname'
+require 'furoshiki/shoes/swt_jar'
+
+include PackageHelpers
+
+describe Furoshiki::Shoes::SwtJar do
+  include_context 'config'
+  include_context 'package'
+
+  context "when creating a .jar" do
+    before :all do
+      output_dir.rmtree if output_dir.exist?
+      output_dir.mkpath
+      Dir.chdir app_dir do
+        @jar_path = subject.package(output_dir)
+      end
+    end
+
+    let(:jar_name) { 'sweet-nebulae.jar' }
+    let(:output_file) { Pathname.new(output_dir.join jar_name) }
+    let(:config) { Furoshiki::Shoes::Configuration.load(config_filename) }
+    subject { Furoshiki::Shoes::SwtJar.new(config) }
+
+    it "creates a .jar" do
+      output_file.should exist
+    end
+
+    it "returns path to .jar" do
+      @jar_path.should eq(output_file.to_s)
+    end
+
+    it "creates .jar smaller than 50MB" do
+      File.size(output_file).should be < 50 * 1024 * 1024
+    end
+
+    it "excludes directories recursively" do
+      jar = Zip::ZipFile.new(output_file)
+      jar.entries.should_not include("dir_to_ignore/file_to_ignore")
+    end
+
+    its(:default_dir) { should eq(output_dir) }
+    its(:filename) { should eq(jar_name) }
+  end
+end

data/spec/shoes/test_app/app.yaml

@@ -0,0 +1,17 @@
+name: Sugar Clouds
+shortname: sweet-nebulae
+ignore:
+  - pkg
+  - dir_to_ignore
+run: bin/hello_world
+gems: rspec
+version: 0.0.1
+release: Mindfully
+icons:
+  osx: img/boots.icns
+  gtk: img/boots_512x512x32.png
+  win32: img/boots.ico
+dmg:
+  ds_store: path/to/custom/.DS_Store
+  background: path/to/custom/background.png
+custom: my custom feature

data/spec/shoes/test_app/bin/hello_world

@@ -0,0 +1,3 @@
+Shoes.app do
+  banner "Hello world"
+end

data/spec/shoes/test_app/dir_to_ignore/file_to_ignore.txt

@@ -0,0 +1 @@
+should be ignored

data/spec/shoes/test_app/sibling.rb

@@ -0,0 +1 @@
+# Just a sibling of 'app.yaml'

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+module PackageHelpers
+  # need these values from a context block, so let doesn't work
+  def spec_dir
+    Pathname.new(__FILE__).join('..').cleanpath
+  end
+
+  def input_dir
+    spec_dir.join 'support', 'zip'
+  end
+end
+
+module ZipHelpers
+  include PackageHelpers
+  # dir = Pathname.new('spec/support/zip')
+  # add_trailing_slash(dir) #=> '/path/to/spec/support/zip/'
+  def add_trailing_slash(dir)
+    dir.to_s + "/"
+  end
+
+  def relative_input_paths(from_dir)
+    Pathname.glob(input_dir + "**/*").map do |p|
+      directory = true if p.directory?
+      relative_path = p.relative_path_from(from_dir).to_s
+      relative_path = add_trailing_slash(relative_path) if directory
+      relative_path
+    end
+  end
+end
+
+spec_root = File.dirname(__FILE__)
+Dir["#{spec_root}/support/**/*.rb"].each { |f| require f }
+

data/spec/support/shared_zip.rb

@@ -0,0 +1,21 @@
+include ZipHelpers
+
+shared_context 'package' do
+  let(:app_dir) { spec_dir.join 'shoes/test_app' }
+  let(:output_dir) { app_dir.join 'pkg' }
+end
+
+shared_context 'zip' do
+  include_context 'package'
+  let(:output_file) { output_dir.join 'zip_directory_spec.zip' }
+  let(:zip) { Zip::ZipFile.open output_file }
+
+  before :all do
+    output_dir.mkpath
+    subject.write
+  end
+
+  after :all do
+    FileUtils.rm_rf output_dir
+  end
+end

data/spec/support/zip/a/a.rb

@@ -0,0 +1,3 @@
+def a
+  puts 'a'
+end

data/spec/support/zip/a/b/c/c.rb

@@ -0,0 +1,3 @@
+def c
+  puts 'c'
+end

data/spec/zip/directory_contents_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'fileutils'
+require 'furoshiki/zip'
+
+describe Furoshiki::Zip::DirectoryContents do
+  subject { Furoshiki::Zip::DirectoryContents.new input_dir, output_file }
+
+  context "output file" do
+    include_context 'zip'
+
+    it "exists" do
+      output_file.should exist
+    end
+
+    it "does not include input directory without parents" do
+      zip.entries.map(&:name).should_not include(add_trailing_slash input_dir.basename)
+    end
+
+    relative_input_paths(input_dir).each do |path|
+      it "includes all children of input directory" do
+        zip.entries.map(&:name).should include(path)
+      end
+    end
+  end
+end

data/spec/zip/directory_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'fileutils'
+require 'furoshiki/zip'
+
+describe Furoshiki::Zip::Directory do
+  subject { Furoshiki::Zip::Directory.new input_dir, output_file }
+
+  context "output file" do
+    include_context 'zip'
+
+    it "exists" do
+      output_file.should exist
+    end
+
+    it "includes input directory without parents" do
+      zip.entries.map(&:name).should include(add_trailing_slash input_dir.basename)
+    end
+
+    relative_input_paths(input_dir.parent).each do |path|
+      it "includes all children of input directory" do
+        zip.entries.map(&:name).should include(path)
+      end
+    end
+
+    it "doesn't include extra files" do
+      number_of_files = Dir.glob("#{input_dir}/**/*").push(input_dir).length
+      zip.entries.length.should eq(number_of_files)
+    end
+  end
+end