invision_support 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e963ce017549ca6962d7486d0657d1b80fbebab7
+  data.tar.gz: 503c935d87c6accfd6f82feee83ff13714ce1eb6
+SHA512:
+  metadata.gz: e6ec565b4ec5befa17daa3f5f362953317d80a2a5e1894402ca6a0af84674960fd51f8289113285c53401103cfd97b9f3f99d7a5be9c93b910d5c3d147ee9a00
+  data.tar.gz: 53cd1d305274f42a1250cd08197e0d7fd58ef518d25eb5365057717f6b07958ccde96e9cc9ebc5740e300377bfbafbd9a7e8e9e6efbd07624e2c2a7744643b49

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in invision_support.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sophy Eung
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# InvisionSupport
+
+Utility library that is used by [sketch.rb](https://github.com/InVisionApp/sketch.rb) and [psd.rb](https://github.com/InVisionApp/psd.rb).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'invision_support'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install invision_support
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/lib/**/*_test.rb'
+end
+task default: :test

data/invision_support.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invision_support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invision_support"
+  spec.version       = InvisionSupport::VERSION
+  spec.authors       = ["Sophy Eung"]
+  spec.email         = ["ungsophy@gmail.com"]
+  spec.description   = "A utility library"
+  spec.summary       = "A utility library"
+  spec.homepage      = "https://github.com/ungsophy/invision_support"
+  spec.license       = "MIT"
+
+  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 'minitest', '~> 5.2.0'
+end

data/lib/invision_support.rb

@@ -0,0 +1,7 @@
+require 'invision_support/version'
+require 'invision_support/filename'
+require 'invision_support/node_name'
+require 'invision_support/path'
+
+module InvisionSupport
+end

data/lib/invision_support/filename.rb

@@ -0,0 +1,26 @@
+module InvisionSupport
+  module Filename
+    def preview_filename(file_path, output_filename = nil)
+      filename = !output_filename.nil? && !output_filename.empty? ? output_filename : file_path
+      filename = File.basename(filename, File.extname(filename))
+
+      filename_in_png(filename)
+    end
+
+    def filename_in_png(str1, str2 = '', has_at2x = false)
+      str2 = '' if str2.nil?
+      str2 = str2.strip.gsub(/^\& /, '').gsub(/\W/, '-')
+
+      at2x = has_at2x ? '@2x' : ''
+
+      arr = str1.strip.split(' ')
+      arr << str2 unless str2.empty?
+
+      index = arr.size > 1 ? 1 : 0
+      filename = arr.slice(index, arr.size).join('-')
+      filename = File.basename(filename, '.png') if filename =~ /\.png$/
+
+      "#{filename}#{at2x}.png"
+    end
+  end
+end

data/lib/invision_support/node_name.rb

@@ -0,0 +1,73 @@
+module InvisionSupport
+  module NodeName
+
+    include Filename
+
+    GLOBAL  = '*'
+    SCREEN  = '+'
+    VARIANT = '&'
+    EXCLUDE = '-'
+
+    ASSET_EXTS = %W(.png .jpg .jpeg .gif)
+
+    # Check if a node is an asset node
+    #
+    # Returns boolean
+    def icon?(node_or_str)
+      filename = get_filename(node_or_str)
+      File.extname(filename).downcase == '.ico'
+    end
+
+    # Check if a node is an asset node
+    #
+    # Returns boolean
+    def asset?(node_or_str)
+      filename = get_filename(node_or_str)
+      extname  = File.extname(filename).downcase
+
+      ASSET_EXTS.include?(extname)
+    end
+
+    # Check if a node is a screen node
+    #
+    # Returns boolean
+    def screen?(node)
+      symbol(node.name).include?(SCREEN) && node.text.nil?
+    rescue NameError
+      symbol(node).include?(SCREEN)
+    end
+
+    # Check if a node is a global node
+    #
+    # Returns boolean
+    def global?(node)
+      symbol(node.name).include?(GLOBAL)
+    end
+
+    # Check if a node is a variant node
+    #
+    # Returns boolean
+    def variant?(node)
+      symbol(node.name).include?(VARIANT)
+    end
+
+    # Check if a node is an exclude node
+    #
+    # Returns boolean
+    def exclude?(node)
+      symbol(node.name).include?(EXCLUDE)
+    end
+
+    private
+
+      def get_filename(node_or_str)
+        node_or_str.name.strip
+      rescue NameError
+        node_or_str
+      end
+
+      def symbol(name)
+        name.strip.split(' ').first
+      end
+  end
+end

data/lib/invision_support/path.rb

@@ -0,0 +1,69 @@
+module InvisionSupport
+  module Path
+
+    include NodeName
+
+    # Example:
+    #   root_path:    /var/www/output/mail-app
+    #   fonts_path:   /var/www/output/mail-app/assets/fonts
+    #   images_path:  /var/www/output/mail-app/assets/images
+    #   screens_path: /var/www/output/mail-app/screens
+    #   icons_path:   /var/www/output/mail-app/icons
+    attr_accessor :root_path, :images_path, :fonts_path, :screens_path, :icons_path,
+                  :output_filename
+
+    # Preview image path e.g. /var/www/output/mail-app/screens/mail-app.png
+    #
+    # Returns string
+    def preview_path(file_path, output_filename = nil)
+      filename = preview_filename(file_path, output_filename)
+      File.join(screens_path, filename)
+    end
+
+    # preview image path in zip e.g. screens/mail-app.png
+    #
+    # Returns string
+    def preview_path_in_zip(file_path, output_filename = nil)
+      filename = preview_filename(file_path, output_filename)
+      File.join(screens_path_in_zip, filename)
+    end
+
+    %w(font image screen icon).each do |type|
+      class_eval(<<END_OF_CODE)
+        def #{type}s_path_in_zip
+          raise ArgumentError, 'root_path is empty' unless root_path
+          raise ArgumentError, '#{type}s_path is empty' unless #{type}s_path
+
+          @#{type}s_path_in_zip ||= #{type}s_path.gsub(/^\#\{root_path\}\\//, '')
+        end
+
+        def #{type}_path_in_zip(name1, name2, has_at2x = false)
+          path = file_path_in_zip('#{type}', name1, name2, has_at2x)
+          extnames = path.split('.').last(2)
+
+          if extnames.last == 'png' && asset?("foo.\#\{extnames.first\}")
+            return path.gsub(/\.png$/, '')
+          end
+
+          path
+        end
+
+        def #{type}_path(name1, name2, has_at2x = false)
+          file_path('#{type}', name1, name2, has_at2x)
+        end
+END_OF_CODE
+    end
+
+    private
+
+      def file_path(type, name1, name2, has_at2x = false)
+        filename = filename_in_png(name1, name2, has_at2x)
+        File.join(__send__("#{type}s_path"), filename)
+      end
+
+      def file_path_in_zip(type, name1, name2, has_at2x = false)
+        filename = filename_in_png(name1, name2, has_at2x)
+        File.join(__send__("#{type}s_path_in_zip"), filename)
+      end
+  end
+end

data/lib/invision_support/version.rb

@@ -0,0 +1,3 @@
+module InvisionSupport
+  VERSION = '0.0.3'
+end

data/test/lib/invision_support/filename_test.rb

@@ -0,0 +1,53 @@
+require './test/test_helper'
+
+class Foo
+  include InvisionSupport::Filename
+end
+
+describe InvisionSupport::Filename do
+  let(:foo) { Foo.new }
+
+  describe '#preview_filename' do
+    describe 'when output_filename is present' do
+      it 'uses output filename' do
+        foo.preview_filename('123-94757-jkfh89.sketch', 'mail-app.sketch').must_equal 'mail-app.png'
+      end
+    end
+
+    describe 'when output_filename is not present' do
+      it 'uses file path' do
+        foo.preview_filename('aaa.sketch', '').must_equal 'aaa.png'
+        foo.preview_filename('aaa.sketch').must_equal 'aaa.png'
+      end
+    end
+  end
+
+  describe '#filename_in_png' do
+    describe 'only one name' do
+      it 'returns filename with .png as extension' do
+        foo.filename_in_png('+ inbox').must_equal 'inbox.png'
+        foo.filename_in_png('* inbox').must_equal 'inbox.png'
+        foo.filename_in_png(' + inbox').must_equal 'inbox.png'
+        foo.filename_in_png('+ inbox.png').must_equal 'inbox.png'
+      end
+    end
+
+    describe 'one name with has_at2x' do
+      it 'returns filename with @2x.png' do
+        foo.filename_in_png('+ inbox', '', true).must_equal 'inbox@2x.png'
+        foo.filename_in_png('* inbox', '', true).must_equal 'inbox@2x.png'
+        foo.filename_in_png(' + inbox', '', true).must_equal 'inbox@2x.png'
+        foo.filename_in_png('+ inbox.png', '', true).must_equal 'inbox@2x.png'
+      end
+    end
+
+    describe 'two names' do
+      it 'returns the combination of two names' do
+        foo.filename_in_png('+ inbox', '& primary', false).must_equal 'inbox-primary.png'
+        foo.filename_in_png('+ inbox', ' & primary', false).must_equal 'inbox-primary.png'
+        foo.filename_in_png(' + inbox', ' & primary', false).must_equal 'inbox-primary.png'
+        foo.filename_in_png(' + inbox', '& primary', false).must_equal 'inbox-primary.png'
+      end
+    end
+  end
+end

data/test/lib/invision_support/node_name_test.rb

@@ -0,0 +1,154 @@
+require './test/test_helper'
+
+FakeNode = Struct.new(:name, :text)
+
+class FakeHelper
+  include InvisionSupport::NodeName
+end
+
+describe InvisionSupport::NodeName do
+  let(:helper) { FakeHelper.new }
+
+  describe '#filename_in_png' do
+    describe 'only one name' do
+      it 'returns filename with .png as extension' do
+        helper.filename_in_png('+ inbox').must_equal 'inbox.png'
+        helper.filename_in_png('* inbox').must_equal 'inbox.png'
+        helper.filename_in_png(' + inbox').must_equal 'inbox.png'
+        helper.filename_in_png('+ inbox.png').must_equal 'inbox.png'
+        helper.filename_in_png('+ inbox.jpg').must_equal 'inbox.jpg.png'
+      end
+    end
+
+    describe 'one name with has_at2x' do
+      it 'returns filename with @2x.png' do
+        helper.filename_in_png('+ inbox', '', true).must_equal 'inbox@2x.png'
+        helper.filename_in_png('* inbox', '', true).must_equal 'inbox@2x.png'
+        helper.filename_in_png(' + inbox', '', true).must_equal 'inbox@2x.png'
+        helper.filename_in_png('+ inbox.png', '', true).must_equal 'inbox@2x.png'
+      end
+    end
+
+    describe 'two names' do
+      it 'returns the combination of two names' do
+        helper.filename_in_png('+ inbox', '& primary', false).must_equal 'inbox-primary.png'
+        helper.filename_in_png('+ inbox', ' & primary', false).must_equal 'inbox-primary.png'
+        helper.filename_in_png(' + inbox', ' & primary', false).must_equal 'inbox-primary.png'
+        helper.filename_in_png(' + inbox', '& primary', false).must_equal 'inbox-primary.png'
+      end
+    end
+  end
+
+  describe '#icon?' do
+    it 'returns true when name has .ico extension' do
+      helper.icon?(FakeNode.new('button.ico')).must_equal true
+      helper.icon?('button.ico').must_equal true
+    end
+
+    it 'returns false when name does not has .ico extension' do
+      helper.icon?(FakeNode.new('button')).must_equal false
+      helper.icon?(FakeNode.new('button.ico.jpg')).must_equal false
+
+      helper.icon?('button').must_equal false
+      helper.icon?('button.ico.jpg').must_equal false
+    end
+  end
+
+  describe '#asset?' do
+    it 'returns true when name has .png, .jpg, .jpeg or .git extension' do
+      helper.asset?(FakeNode.new('button.png')).must_equal true
+      helper.asset?(FakeNode.new('button.jpg')).must_equal true
+      helper.asset?(FakeNode.new('button.jpeg')).must_equal true
+      helper.asset?(FakeNode.new('button.gif')).must_equal true
+
+      helper.asset?('button.png').must_equal true
+      helper.asset?('button.jpg').must_equal true
+      helper.asset?('button.jpeg').must_equal true
+      helper.asset?('button.gif').must_equal true
+    end
+
+    it 'returns false when name does not has .png extension' do
+      helper.asset?(FakeNode.new('button')).must_equal false
+      helper.asset?(FakeNode.new('button.png.ico')).must_equal false
+      helper.asset?(FakeNode.new('button.bmp')).must_equal false
+
+      helper.asset?('button').must_equal false
+      helper.asset?('button.png.ico').must_equal false
+      helper.asset?('button.bmp').must_equal false
+    end
+  end
+
+  describe '#screen?' do
+    it 'returns true when name has + prefix and node is not text node' do
+      node1 = FakeNode.new('+ inbox')
+      node2 = FakeNode.new(' + inbox')
+      node3 = FakeNode.new(' +  inbox')
+
+      helper.screen?(node1).must_equal true
+      helper.screen?(node2).must_equal true
+      helper.screen?(node3).must_equal true
+    end
+
+    it 'returns false when name has no + prefix' do
+      node1 = FakeNode.new('inbox')
+      node2 = FakeNode.new('inbox', {})
+
+      helper.screen?(node1).must_equal false
+      helper.screen?(node2).must_equal false
+    end
+
+    it 'returns false when name has + prefix, but node is text node' do
+      node = FakeNode.new('+ inbox', {})
+
+      helper.screen?(node).must_equal false
+    end
+  end
+
+  describe '#global?' do
+    it 'returns true when name has * prefix' do
+      node1 = FakeNode.new('* inbox')
+      node2 = FakeNode.new(' * inbox')
+      node3 = FakeNode.new(' *  inbox')
+
+      helper.global?(node1).must_equal true
+      helper.global?(node2).must_equal true
+      helper.global?(node3).must_equal true
+    end
+
+    it 'returns false when name has no * prefix' do
+      node = FakeNode.new('inbox')
+
+      helper.screen?(node).must_equal false
+    end
+  end
+
+  describe '#variant?' do
+    it 'returns true when name has & prefix' do
+      node1 = FakeNode.new('& inbox')
+      node2 = FakeNode.new(' & inbox')
+      node3 = FakeNode.new(' &  inbox')
+
+      helper.variant?(node1).must_equal true
+      helper.variant?(node2).must_equal true
+      helper.variant?(node3).must_equal true
+    end
+
+    it 'returns false when name has no * prefix' do
+      node = FakeNode.new('inbox')
+
+      helper.variant?(node).must_equal false
+    end
+  end
+
+  describe '#exclude?' do
+    it 'returns true when name has & prefix' do
+      node1 = FakeNode.new('- inbox')
+      node2 = FakeNode.new(' - inbox')
+      node3 = FakeNode.new(' -  inbox')
+
+      helper.exclude?(node1).must_equal true
+      helper.exclude?(node2).must_equal true
+      helper.exclude?(node3).must_equal true
+    end
+  end
+end

data/test/lib/invision_support/path_test.rb

@@ -0,0 +1,94 @@
+require './test/test_helper'
+
+class Foo
+  include InvisionSupport::Path
+end
+
+describe InvisionSupport::Path do
+  def create_foo
+    foo = Foo.new
+    foo.root_path    = '/foo'
+    foo.screens_path = '/foo/screens'
+    foo.images_path  = '/foo/assets/images'
+    foo.fonts_path   = '/foo/assets/fonts'
+    foo.icons_path   = '/foo/assets/icons'
+
+    foo
+  end
+
+  let(:foo) { create_foo }
+
+  describe '#screens_path_in_zip' do
+    it 'returns screens path in zip file' do
+      foo.screens_path_in_zip.must_equal 'screens'
+    end
+  end
+
+  describe '#screen_path' do
+    it 'returns screen path' do
+      foo.screen_path('+ inbox', '').must_equal '/foo/screens/inbox.png'
+    end
+  end
+
+  describe '#screen_path_in_zip' do
+    it 'returns screen path in zip' do
+      foo.screen_path_in_zip('+ inbox', '').must_equal 'screens/inbox.png'
+    end
+  end
+
+  describe '#preview_path' do
+    it 'returns preview path' do
+      foo.preview_path('/foo/var/sample.sketch').must_equal '/foo/screens/sample.png'
+    end
+  end
+
+  describe '#preview_path_in_zip' do
+    it 'returns preview path in zip' do
+      foo.preview_path_in_zip('/foo/var/sample.sketch', 'new-sample.sketch').must_equal 'screens/new-sample.png'
+    end
+  end
+
+  describe '#images_path_in_zip' do
+    it 'returns images path in zip file' do
+      foo.images_path_in_zip.must_equal 'assets/images'
+    end
+  end
+
+  describe '#image_path' do
+    it 'returns image path' do
+      foo.image_path('button.png', '').must_equal '/foo/assets/images/button.png'
+    end
+  end
+
+  describe '#image_path_in_zip' do
+    it 'returns image path in zip' do
+      foo.image_path_in_zip('+ inbox', '').must_equal 'assets/images/inbox.png'
+      foo.image_path_in_zip('inbox.gif.png', '').must_equal 'assets/images/inbox.gif'
+      foo.image_path_in_zip('inbox.jpg.png', '').must_equal 'assets/images/inbox.jpg'
+    end
+  end
+
+  describe '#fonts_path_in_zip' do
+    it 'returns fonts path in zip file' do
+      foo.fonts_path_in_zip.must_equal 'assets/fonts'
+    end
+  end
+
+  describe '#icons_path_in_zip' do
+    it 'returns icons path in zip file' do
+      foo.icons_path_in_zip.must_equal 'assets/icons'
+    end
+  end
+
+  describe '#icon_path' do
+    it 'returns icon path' do
+      foo.icon_path('btn.png', '').must_equal '/foo/assets/icons/btn.png'
+    end
+  end
+
+  describe '#icon_path_in_zip' do
+    it 'returns icon path in zip' do
+      foo.icon_path_in_zip('btn.png', '').must_equal 'assets/icons/btn.png'
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'pp'
+
+require 'invision_support'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: invision_support
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sophy Eung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+description: A utility library
+email:
+- ungsophy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- invision_support.gemspec
+- lib/invision_support.rb
+- lib/invision_support/filename.rb
+- lib/invision_support/node_name.rb
+- lib/invision_support/path.rb
+- lib/invision_support/version.rb
+- test/lib/invision_support/filename_test.rb
+- test/lib/invision_support/node_name_test.rb
+- test/lib/invision_support/path_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ungsophy/invision_support
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A utility library
+test_files:
+- test/lib/invision_support/filename_test.rb
+- test/lib/invision_support/node_name_test.rb
+- test/lib/invision_support/path_test.rb
+- test/test_helper.rb