xcres 0.4.0

data/spec/unit/model/xcassets/resource_image_spec.rb

@@ -0,0 +1,141 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module XCAssetsSpec
+  describe 'XCRes::XCAssets::ResourceImage' do
+
+    def subject
+      ResourceImage
+    end
+
+    def input_hash
+      {
+        filename: "doge.png",
+        scale: 2,
+        orientation: "portrait",
+        size: "40x40",
+        idiom: "universal",
+        subtype: "retina4",
+        extent: "full-screen",
+        minimum_system_version: "7.0",
+      }
+    end
+
+    def serialized_img_hash
+      {
+        "filename" => "doge.png",
+        "scale" => "2x",
+        "orientation" => "portrait",
+        "size" => "40x40",
+        "idiom" => "universal",
+        "subtype" => "retina4",
+        "extent" => "full-screen",
+        "minimum-system-version" => "7.0",
+      }
+    end
+
+    shared 'has expected attributes' do
+      it 'should have expected attributes' do
+        @img.filename.should.be.eql? "doge.png"
+        @img.scale.should.be.eql? 2
+        @img.orientation.should.be.eql? "portrait"
+        @img.size.should.be.eql? "40x40"
+        @img.idiom.should.be.eql? "universal"
+        @img.subtype.should.be.eql? "retina4"
+        @img.extent.should.be.eql? "full-screen"
+        @img.minimum_system_version.should.be.eql? "7.0"
+      end
+    end
+
+    describe '::read' do
+      describe 'with an empty hash' do
+        it 'should be a valid instance' do
+          subject.read({}).should.be.an.instance_of?(subject)
+        end
+      end
+
+      describe 'with all attributes given as hash' do
+        before do
+          @img = subject.read(serialized_img_hash)
+        end
+
+        behaves_like 'has expected attributes'
+      end
+    end
+
+    describe '#initialize' do
+      describe 'without any arguments' do
+        it 'should be a valid instance' do
+          subject.new.should.be.an.instance_of?(subject)
+        end
+      end
+
+      describe 'with an empty hash' do
+        it 'should be a valid instance' do
+          subject.new({}).should.be.an.instance_of?(subject)
+        end
+      end
+
+      describe 'with all attributes given as hash' do
+        before do
+          @img = subject.new(input_hash)
+        end
+
+        behaves_like 'has expected attributes'
+      end
+    end
+
+    describe '#read' do
+      describe 'with an empty hash' do
+        it 'should be a valid instance' do
+          subject.new.read({}).should.be.an.instance_of?(subject)
+        end
+      end
+
+      describe 'with all attributes given as hash' do
+        before do
+          @img = subject.new.read(serialized_img_hash)
+        end
+
+        behaves_like 'has expected attributes'
+      end
+    end
+
+    describe '#to_hash' do
+      it 'should serialize to expected hash' do
+        subject.new(input_hash).to_hash.should.be.eql?(serialized_img_hash)
+      end
+    end
+
+    describe '#==' do
+      before do
+        @img = subject.new(input_hash)
+      end
+
+      describe 'same class' do
+        it 'should be equal for same hashes' do
+          other_img = subject.new(input_hash)
+          @img.should.be ==(other_img)
+        end
+      end
+
+      describe 'other class' do
+        before do
+          @other_img = stub('ResourceImage')
+          @other_img.stubs(:respond_to?).with(:to_hash).returns(true)
+          @other_img.expects(:to_hash).returns({ name: 'Doge' })
+        end
+
+        it 'should be equal for equal hash representations' do
+          @img.expects(:to_hash).returns({ name: 'Doge' })
+          @img.should.be ==(@other_img)
+        end
+
+        it 'should differ if hash representations are different' do
+          @img.expects(:to_hash).returns({ name: 'NyanCat' })
+          @img.should.not.be ==(@other_img)
+        end
+      end
+    end
+
+  end
+end

data/spec/unit/model/xcassets/resource_spec.rb

@@ -0,0 +1,174 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+module XCAssetsSpec
+  describe 'XCRes::XCAssets::Resource' do
+
+    def subject
+      Resource
+    end
+
+    before do
+      # Make protected and private methods accessible for specs
+      subject.send(:public, *subject.protected_instance_methods)
+    end
+
+    def expected_info
+      {
+        "version" => 1,
+        "author" => "xcode"
+      }
+    end
+
+    def expected_contents
+      {
+        "images" => [
+          {
+            "idiom" => "universal",
+            "scale" => "1x",
+            "filename" => "doge.png"
+          },
+          {
+            "idiom" => "universal",
+            "scale" => "2x",
+            "filename" => "doge@2x.png"
+          }
+        ],
+        "info" => expected_info
+      }
+    end
+
+    describe "#initialize" do
+      before do
+        @bundle = mock('Bundle')
+      end
+
+      it 'sets the first argument as attribute bundle' do
+        subject.new(@bundle, imageset_fixture_path).bundle
+          .should.be.eql?(@bundle)
+      end
+
+      it 'sets the second argument as attribute path' do
+        subject.new(@bundle, imageset_fixture_path).path
+          .should.be.eql?(imageset_fixture_path)
+      end
+    end
+
+    describe "instance methods" do
+      before do
+        @res = subject.new(
+          Bundle.new(xcassets_fixture_path),
+          imageset_fixture_path
+        )
+      end
+
+      describe "#name" do
+        it 'should match the name' do
+          @res.name.should.be.eql?('Doge')
+        end
+      end
+
+      describe "#type" do
+        it 'should match the type' do
+          @res.type.should.be.eql?('imageset')
+        end
+      end
+
+      describe "#info" do
+        it 'should match the info' do
+          @res.info.should.be.eql?({ "version" => 1, "author" => "xcode" })
+        end
+      end
+
+      describe "#images" do
+        before do
+          @images = [mock('ResourceImageA'), mock('ResourceImageB')]
+        end
+
+        it 'should return the images, which were set, if any' do
+          @res.images = @images
+          @res.images.should.be.eql?(@images)
+        end
+
+        it 'should parse the contents lazily, if no images are set' do
+          @res.expects(:read_images).returns(@images)
+          @res.images.should.be.eql?(@images)
+        end
+      end
+
+      describe "#to_hash" do
+        it 'should equal the original parsed JSON file contents' do
+          @res.to_hash.should.be.eql?(expected_contents)
+        end
+      end
+
+      describe "#json_path" do
+        it 'should match the expected path' do
+          @res.json_path.should.be.eql?(imageset_fixture_path + 'Contents.json')
+        end
+      end
+
+      describe "#parsed_contents" do
+        it 'should equal the expected parsed JSON file contents' do
+          @res.parsed_contents.should.be.eql?(expected_contents)
+        end
+      end
+
+      describe "#read" do
+        it 'should return the resource' do
+          @res.read.should.be.eql?(@res)
+        end
+      end
+
+      describe "#read_info" do
+        it 'should return the expected info' do
+          @res.read_info.should.be.eql?(expected_info)
+        end
+      end
+
+      describe "#read_images" do
+        it 'should return the expected images' do
+          @res.images.should.be.eql? [
+            ResourceImage.new(idiom: 'universal', scale: 1, filename: 'doge.png'),
+            ResourceImage.new(idiom: 'universal', scale: 2, filename: 'doge@2x.png'),
+          ]
+        end
+      end
+
+      describe "#==" do
+        describe 'same class' do
+          it 'should be equal for equal file references' do
+            other_res = subject.new(
+              Bundle.new(xcassets_fixture_path),
+              imageset_fixture_path
+            )
+            @res.should.be ==(other_res)
+          end
+        end
+
+        describe 'other class' do
+          before do
+            @res_img_a = stub('ResourceImageA')
+
+            @other_res = stub('Resource')
+            @other_res.stubs(:respond_to?).with(:to_hash).returns(true)
+            @other_res.expects(:to_hash).returns({
+              images: [@res_img_a]
+            })
+          end
+
+          it 'should be equal for equal hash representations' do
+            @res.expects(:to_hash).returns({ images: [@res_img_a] })
+            @res.should.be ==(@other_res)
+          end
+
+          it 'should differ if hash representations are different' do
+            @res.expects(:to_hash).returns({ images: [stub('ResourceImageB')] })
+            @res.should.not.be ==(@other_res)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/spec/unit/model/xcassets/spec_helper.rb

@@ -0,0 +1,31 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+require 'xcres/model/xcassets/bundle'
+
+module XCAssetsSpec
+  # Bring the classes into the namespace in which the specs are defined.
+  # This is better than into the global namespace, which could influence the
+  # behavior of other specs.
+  include XCRes::XCAssets
+
+  module Helper
+    def xcassets_fixture_path
+      fixture_path + 'Example/Example/Images.xcassets'
+    end
+
+    def imageset_fixture_path
+      xcassets_fixture_path + 'Doge.imageset'
+    end
+  end
+
+  # Define in each root context a inheritable before, which will extend each
+  # sub context with Helper.
+  def self.describe(description, &block)
+    super description do
+      before do
+        extend Helper
+      end
+      instance_eval(&block)
+    end
+  end
+
+end

data/spec/unit/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bacon'
+require 'pretty_bacon'
+require 'mocha-on-bacon'
+require 'xcres'
+require 'pathname'
+
+def fixture_path
+  @fixture_path ||= Pathname(File.expand_path('../../fixtures', __FILE__))
+end
+
+def xcodeproj
+  Xcodeproj::Project.open(fixture_path + 'Example/Example.xcodeproj')
+end
+
+def app_target
+  xcodeproj.targets.find { |t| t.name == 'Example' }
+end

data/xcres.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xcres/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xcres"
+  spec.version       = XCRes::VERSION
+  spec.authors       = ["Marius Rackwitz"]
+  spec.homepage      = "https://github.com/mrackwitz/xcres"
+  spec.email         = ["git@mariusrackwitz.de"]
+  spec.license       = "MIT"
+
+  spec.description   = "xcres searches your Xcode project for resources" \
+                       "and generates an index as struct constants."
+  spec.summary       = %q{
+  `xcres` searches your Xcode project for resources and generates an index
+  as struct constants. So you will never have to reference a resource, without
+  knowing already at compile if it exists or not.
+  }
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bacon', '~> 1.1'
+  spec.add_development_dependency 'prettybacon'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'mocha-on-bacon'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'inch'
+  spec.add_development_dependency 'psych'
+
+  spec.add_runtime_dependency 'clamp', '~> 0.6.3'
+  spec.add_runtime_dependency 'colored', '~> 1.2'
+  spec.add_runtime_dependency 'activesupport', '>= 3.2.15', '< 4'
+  spec.add_runtime_dependency 'xcodeproj', '~> 0.18'
+  spec.add_runtime_dependency 'libxml-ruby'
+end