montage 0.2.1

data/spec/montage/commands/init_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project in the current directory' do
+  before(:all) do
+    @runner = Montage::Spec::InitCommandRunner.new.run!
+  end
+
+  it { @runner.should be_success }
+  it { @runner.stdout.should =~ /Your project was created/ }
+  it { @runner.path_to_file('montage.yml').should be_file }
+
+  # Example sources?
+
+  it 'should copy the sample source images' do
+    %w( book box-label calculator calendar-month camera eraser ).each do |source|
+      (@runner.project.paths.sources + "#{source}.png").should be_file
+    end
+  end
+
+  # Config
+
+  describe 'the montage.yml file' do
+    before(:all) do
+      @config = File.read(@runner.project.paths.config)
+    end
+
+    it { @config.should =~ %r{^  config.sprites:\s+"public/images/sprites"$} }
+    it { @config.should =~ %r{^  config.sources:\s+"public/images/sprites/src"$} }
+  end
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project in a path which has a ./config directory' do
+  before(:all) do
+    @runner = Montage::Spec::InitCommandRunner.new
+    @runner.mkdir('config')
+    @runner.run!
+  end
+
+  it { @runner.should be_success }
+  it { @runner.stdout.should =~ /Your project was created/ }
+  it { @runner.path_to_file('config/montage.yml').should be_file }
+  it { @runner.path_to_file('montage.yml').should_not be_file }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project in an existing project directory' do
+  before(:all) do
+    @runner = Montage::Spec::InitCommandRunner.new
+    2.times { @runner.run! }
+  end
+
+  it { @runner.should be_failure }
+  it { @runner.stdout.should =~ /A Montage project already exists in the current directory/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project in an existing project which has a ./config directory' do
+  before(:all) do
+    @runner = Montage::Spec::InitCommandRunner.new
+    @runner.mkdir('config')
+    2.times { @runner.run! }
+  end
+
+  it { @runner.should be_failure }
+  it { @runner.stdout.should =~ /A Montage project already exists in the current directory/ }
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project with a custom sprites directory' do
+  describe 'the montage.yml file' do
+    before(:all) do
+      @runner = Montage::Spec::InitCommandRunner.new(
+        :sprites => 'public/other').run!
+
+      @config = File.read(@runner.project.paths.config)
+    end
+
+    it { @config.should =~ %r{^  config.sprites:\s+"public/other"$} }
+    it { @config.should =~ %r{^  config.sources:\s+"public/other/src"$} }
+  end
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project with an absolute custom sprites directory' do
+  describe 'the montage.yml file' do
+    before(:all) do
+      @runner = Montage::Spec::InitCommandRunner.new(
+        :sprites => '/tmp').run!
+
+      @config = File.read(@runner.project.paths.config)
+    end
+
+    it { @config.should =~ %r{^  config.sprites:\s+"/tmp"$} }
+    it { @config.should =~ %r{^  config.sources:\s+"/tmp/src"$} }
+  end
+end
+
+# ----------------------------------------------------------------------------
+
+context 'Generating a new project with a custom sprites and sources directory' do
+  describe 'the montage.yml file' do
+    before(:all) do
+      @runner = Montage::Spec::InitCommandRunner.new(
+        :sprites => 'public/other', :sources => 'src/sprites').run!
+
+      @config = File.read(@runner.project.paths.config)
+    end
+
+    it { @config.should =~ %r{^  config.sprites:\s+"public/other"$} }
+    it { @config.should =~ %r{^  config.sources:\s+"src/sprites"$} }
+  end
+end

data/spec/montage/core_ext_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe String do
+  it 'should not do anything when there is no leading whitespace' do
+    "abc\ndef\nhij".unindent.should == "abc\ndef\nhij"
+  end
+
+  it 'should remove leading whitespace consistently' do
+    "  abc\n  def\n  hij".unindent.should == "abc\ndef\nhij"
+  end
+
+  it 'should remove no whitespace when one line has none' do
+    "  abc\ndef\n  hij".unindent.should == "  abc\ndef\n  hij"
+  end
+
+  it 'should ignore blank lines' do
+    "  abc\n  def\n\n  hij".unindent.should == "abc\ndef\n\nhij"
+  end
+
+  it 'should remove no more whitespace than required' do
+    # Left-most at beginning.
+    unindented = "  abc\n    def\n    hij\n    lmn".unindent
+    unindented.should == "abc\n  def\n  hij\n  lmn"
+
+    # Left-most in middle.
+    unindented = "    abc\n    def\n  hij\n    lmn".unindent
+    unindented.should == "  abc\n  def\nhij\n  lmn"
+
+    # Left-most at end.
+    unindented = "    abc\n    def\n    hij\n  lmn".unindent
+    unindented.should == "  abc\n  def\n  hij\nlmn"
+  end
+end

data/spec/montage/project_spec.rb

@@ -0,0 +1,181 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Montage::Project do
+  subject { Montage::Project }
+
+  # Class Methods ============================================================
+
+  # --- find -----------------------------------------------------------------
+
+  it { should respond_to(:find) }
+
+  describe '.find' do
+    describe 'when given a project root with montage.yml in the root' do
+      before(:all) do
+        @project = Montage::Project.find(fixture_path(:root_config))
+        @root    = Pathname.new(fixture_path(:root_config))
+        @config  = Pathname.new(fixture_path(:root_config, 'montage.yml'))
+      end
+
+      it_should_behave_like 'a project with correct paths'
+    end # when given a project root with montage.yml in the root
+
+    describe 'when given a project root with montage.yml in ./config' do
+      before(:all) do
+        @project = Montage::Project.find(fixture_path(:directory_config))
+        @root    = Pathname.new(fixture_path(:directory_config))
+        @config  = Pathname.new(
+          fixture_path(:directory_config, 'config/montage.yml'))
+      end
+
+      it_should_behave_like 'a project with correct paths'
+    end # when given a project root with montage.yml in ./config
+
+    describe 'when given a project subdirectory' do
+      before(:all) do
+        @project = Montage::Project.find(fixture_path(:subdirs, 'sub/sub'))
+        @root    = Pathname.new(fixture_path(:subdirs))
+        @config  = Pathname.new(fixture_path(:subdirs, 'montage.yml'))
+      end
+
+      it_should_behave_like 'a project with correct paths'
+    end # when given a project subdirectory
+
+    describe 'when given a configuration file in the root' do
+      before(:all) do
+        @project = Montage::Project.find(
+          fixture_path(:root_config, 'montage.yml'))
+
+        @root    = Pathname.new(fixture_path(:root_config))
+        @config  = Pathname.new(fixture_path(:root_config, 'montage.yml'))
+      end
+
+      it_should_behave_like 'a project with correct paths'
+    end # when given a configuration file in the root
+
+    describe 'when given a configuration file in ./config' do
+      before(:all) do
+        @project = Montage::Project.find(
+          fixture_path(:directory_config, 'config/montage.yml'))
+        @root    = Pathname.new(fixture_path(:directory_config))
+        @config  = Pathname.new(
+          fixture_path(:directory_config, 'config/montage.yml'))
+      end
+
+      it_should_behave_like 'a project with correct paths'
+    end # when given a configuration file in ./config
+
+    describe 'when the config file specifies custom directories' do
+      before(:all) do
+        @project = Montage::Project.find(fixture_path(:custom_dirs))
+        @base = Pathname.new(fixture_path(:custom_dirs)) + 'custom'
+      end
+
+      it 'should set the sources path' do
+        @project.paths.sources.should == @base + 'sources'
+      end
+
+      it 'should set the sprites path' do
+        @project.paths.sprites.should == @base + 'output'
+      end
+
+      it 'should set the SASS output path' do
+        @project.paths.sass.should == @base + 'sass'
+      end
+    end
+
+    describe 'when the config file specifies not to generate Sass' do
+      before(:all) do
+        @helper = Montage::Spec::ProjectHelper.new
+        @helper.write_config <<-CONFIG
+        ---
+          config.sass: false
+        CONFIG
+      end
+
+      it 'should set the SASS output path to false' do
+        @helper.project.paths.sass.should be_false
+      end
+    end
+
+    describe 'when given an empty directory' do
+      it 'should raise an error' do
+        running = lambda { Montage::Project.find(fixture_path(:empty)) }
+        running.should raise_exception(Montage::MissingProject)
+      end
+    end # when given an empty directory
+
+    describe 'when given an invalid path' do
+      it 'should raise an error' do
+        running = lambda { Montage::Project.find('__invalid__') }
+        running.should raise_exception(Montage::MissingProject)
+      end
+    end # when given an invalid path
+  end
+
+  # Instance Methods =========================================================
+
+  it { should have_public_method_defined(:paths) }
+
+  # --- sprites --------------------------------------------------------------
+
+  it { should have_public_method_defined(:sprites) }
+
+  describe '#sprites' do
+    context "when the project has one sprite with two sources" do
+      before(:each) do
+        @helper = Montage::Spec::ProjectHelper.new
+        @helper.write_config <<-CONFIG
+        ---
+          sprite_one:
+            - one
+            - two
+        CONFIG
+
+        @helper.write_source('one', 100, 25)
+        @helper.write_source('two', 100, 25)
+      end
+
+      it 'should return an array with one element' do
+        @helper.project.sprites.should have(1).sprite
+      end
+
+      it 'should have two sources in the sprite' do
+        @helper.project.sprites.first.should have(2).sources
+      end
+    end # when the project has one sprite with two sources
+
+    context "when the project has two sprites with 2/1 sources" do
+      before(:each) do
+        @helper = Montage::Spec::ProjectHelper.new
+        @helper.write_config <<-CONFIG
+        ---
+          sprite_one:
+            - one
+            - two
+
+          sprite_two:
+            - three
+        CONFIG
+
+        @helper.write_source('one',   100, 25)
+        @helper.write_source('two',   100, 25)
+        @helper.write_source('three', 100, 25)
+      end
+
+      it 'should return an array with two elements' do
+        @helper.project.sprites.should have(2).sprite
+      end
+
+      it 'should have two sources in the first sprite' do
+        @helper.project.sprite('sprite_one').should have(2).sources
+      end
+
+      it 'should have one source in the second sprite' do
+        @helper.project.sprite('sprite_two').should have(1).sources
+      end
+    end # when the project has one sprite with two sources
+
+  end
+
+end

data/spec/montage/sass_builder_spec.rb

@@ -0,0 +1,269 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Montage::SassBuilder do
+  subject { Montage::SassBuilder }
+
+  # --- write ----------------------------------------------------------------
+
+  it { should have_public_method_defined(:write) }
+
+  describe '#write' do
+    before(:each) do
+      @helper = Montage::Spec::ProjectHelper.new
+    end
+
+    context 'with a project containing a single sprite and two sources' do
+      before(:each) do
+        @helper.write_config <<-CONFIG
+        ---
+          only:
+            - one
+            - two
+        CONFIG
+
+        @helper.write_source('one')
+        @helper.write_source('two')
+
+        Montage::SassBuilder.new(@helper.project).write
+
+        @sass_path = @helper.path_to_file(
+          'public/stylesheets/sass/_montage.sass')
+
+        if @sass_path.file?
+          @sass = File.read(@helper.path_to_file(
+            'public/stylesheets/sass/_montage.sass'))
+        else
+          @sass = 'MISSING SASS FILE'
+        end
+      end
+
+      it 'should save the Sass file' do
+        @sass_path.should be_file
+      end
+
+      it 'should contain the sprite mixin' do
+        @sass.should =~ /^=only-sprite/
+      end
+
+      it 'should include a condition for the "one" source' do
+        expected = Regexp.escape(
+          %[  @if $icon == "one"\n] +
+          %[    $y_offset: $y_offset - 0px])
+
+        @sass.should =~ /^#{expected}/
+      end
+
+      it 'should include a condition for the "two" source' do
+        expected = Regexp.escape(
+          %[  @else if $icon == "two"\n] +
+          %[    $y_offset: $y_offset - #{20 + @helper.project.padding}px])
+
+        @sass.should =~ /^#{expected}/
+      end
+
+      it 'should include the background statement' do
+        @sass.should include(
+          "  background: url(/images/sprites/only.png)")
+      end
+
+      describe 'the generated mixins' do
+        it 'should correctly position the first source' do
+          sass = Sass::Engine.new(<<-SASS.unindent).render
+            @import #{@helper.project.paths.sass.realpath + '_montage.sass'}
+
+            .rule
+              +only-sprite("one")
+          SASS
+
+          sass.should include(
+            'background: url(/images/sprites/only.png) 0px 0px no-repeat')
+        end
+
+        it 'should correctly position the second source' do
+          sass = Sass::Engine.new(<<-SASS.unindent).render
+            @import #{@helper.project.paths.sass.realpath + '_montage.sass'}
+
+            .rule
+              +only-sprite("two")
+          SASS
+
+          sass.should include(
+            'background: url(/images/sprites/only.png) 0px -40px no-repeat')
+        end
+
+        it 'should apply x-offsets' do
+          sass = Sass::Engine.new(<<-SASS.unindent).render
+            @import #{@helper.project.paths.sass.realpath + '_montage.sass'}
+
+            .rule
+              +only-sprite("one", 5px)
+          SASS
+
+          sass.should include(
+            'background: url(/images/sprites/only.png) 5px 0px no-repeat')
+        end
+
+        it 'should apply y-offsets' do
+          sass = Sass::Engine.new(<<-SASS.unindent).render
+            @import #{@helper.project.paths.sass.realpath + '_montage.sass'}
+
+            .rule
+              +only-sprite("two", 0px, -10px)
+          SASS
+
+          # -20px (source one) - 20px (padding) - 10px (third arg) = -50px
+          sass.should include(
+            'background: url(/images/sprites/only.png) 0px -50px no-repeat')
+        end
+      end
+    end # with a project containing a single sprite and two sources
+
+    context 'with a project containing two sprites, each with two sources' do
+      before(:each) do
+        @helper.write_config <<-CONFIG
+        ---
+          first:
+            - one
+            - two
+
+          second:
+            - three
+            - four
+        CONFIG
+
+        %w( one two three four ).each do |source|
+          @helper.write_source(source)
+        end
+
+        Montage::SassBuilder.new(@helper.project).write
+
+        @sass_path = @helper.path_to_file(
+          'public/stylesheets/sass/_montage.sass')
+
+        if @sass_path.file?
+          @sass = File.read(@helper.path_to_file(
+            'public/stylesheets/sass/_montage.sass'))
+        else
+          @sass = 'MISSING SASS FILE'
+        end
+      end
+
+      it 'should save the Sass file' do
+        @sass_path.should be_file
+      end
+
+      it 'should contain both sprite mixins' do
+        @sass.should =~ /^=first-sprite/
+        @sass.should =~ /^=second-sprite/
+      end
+
+      it 'should include a condition for the "one" source' do
+        expected = Regexp.escape(
+          %[  @if $icon == "one"\n] +
+          %[    $y_offset: $y_offset - 0px])
+
+        @sass.should =~ /^#{expected}/
+      end
+
+      it 'should include a condition for the "two" source' do
+        expected = Regexp.escape(
+          %[  @else if $icon == "two"\n] +
+          %[    $y_offset: $y_offset - #{20 + @helper.project.padding}px])
+
+        @sass.should =~ /^#{expected}/
+      end
+
+      it 'should include a condition for the "three" source' do
+        expected = Regexp.escape(
+          %[  @if $icon == "three"\n] +
+          %[    $y_offset: $y_offset - 0px])
+
+        @sass.should =~ /^#{expected}/
+      end
+
+      it 'should include a condition for the "four" source' do
+        expected = Regexp.escape(
+          %[  @else if $icon == "four"\n] +
+          %[    $y_offset: $y_offset - #{20 + @helper.project.padding}px])
+
+        @sass.should =~ /^#{expected}/
+      end
+
+      it 'should include the background statement for the first sprite' do
+        @sass.should include(
+          "  background: url(/images/sprites/first.png)")
+      end
+
+      it 'should include the background statement for the second sprite' do
+        @sass.should include(
+          "  background: url(/images/sprites/second.png)")
+      end
+    end # with a project containing two sprites, each with two sources
+
+    context 'with a project using a custom SASS location' do
+      before(:each) do
+        @helper.write_config <<-CONFIG
+        ---
+          config.sass: "public/sass"
+
+          only:
+            - one
+        CONFIG
+
+        @helper.write_source('one')
+        Montage::SassBuilder.new(@helper.project).write
+      end
+
+      it 'should save the Sass file' do
+        @helper.path_to_file(
+          'public/sass/_montage.sass').should be_file
+      end
+    end # with a project using a custom SASS location
+
+    context 'with a project using a custom SASS location with a file name' do
+      before(:each) do
+        @helper.write_config <<-CONFIG
+        ---
+          config.sass: "public/sass/_here.sass"
+
+          only:
+            - one
+        CONFIG
+
+        @helper.write_source('one')
+        Montage::SassBuilder.new(@helper.project).write
+      end
+
+      it 'should save the Sass file' do
+        @helper.path_to_file(
+          'public/sass/_here.sass').should be_file
+      end
+    end # with a project using a custom SASS location with a file name
+
+    context 'with a project using a custom sprite_url setting' do
+      before(:each) do
+        @helper.write_config <<-CONFIG
+        ---
+          config.sprite_url: "/right/about/here"
+
+          only:
+            - one
+        CONFIG
+
+        @helper.write_source('one')
+
+        Montage::SassBuilder.new(@helper.project).write
+
+        @sass = File.read(@helper.path_to_file(
+          'public/stylesheets/sass/_montage.sass'))
+      end
+
+      it 'should include the background statement' do
+        @sass.should include(
+          "  background: url(/right/about/here/only.png)")
+      end
+    end # with a project using a custom sprite_url setting
+
+  end # build
+
+end