slice_rename 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9ccdfae67abd4149444be16e8d5ab35f8c34ff2
+  data.tar.gz: 09649ed5652c83d1b4554bc39565574daae3d2eb
+SHA512:
+  metadata.gz: 0e62eda7b7534ac40c6ec42099c947c262fa299730eb78b4dd294de4f85ea7f6bedd2c5f39c7065c8537ff2507c5aaea5fae0faded4ab5f74fd7fe8c18a2a8bf
+  data.tar.gz: 1bdafecf17d09c8a739fab7d9aeff36bd6e3b73fe203483305771f521d5ec8d863bb16bfe194c88778f5d53be172330bae6fb6857ed7ddfcf7e4d9199c9e8ede

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+ruby "2.3.1"
+
+gemspec
+
+gem "mini_magick"
+
+group :test, :development do
+  gem "guard"
+  gem "guard-rspec", require: false
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    slice_rename (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.10)
+    method_source (0.8.2)
+    mini_magick (4.5.1)
+    nenv (0.3.0)
+    notiffany (0.1.0)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    ruby_dep (1.3.1)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  mini_magick
+  rspec
+  slice_rename!
+
+RUBY VERSION
+   ruby 2.3.1p112
+
+BUNDLED WITH
+   1.12.4

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Zoee Silcock mrzoee@gmail.com
+
+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,37 @@
+# Slice Rename
+Slice an image and give each slice a specific name.
+
+# Usage
+The CLI takes two arguments, the path to the image to be sliced and a
+configuration file. The output will be placed in the same folder as the input
+image. If you don't provide a configuration file it will use default settings
+which aren't useful for anything.
+
+```
+-c, --config MANDATORY  Configuration file (see below)
+-d, --debug             Output debug info
+-v, --version           Display the version
+-h, --help              Display this message
+```
+
+## Configuration
+See the example which is located at `spec/fixtures/config_example.yml`. The
+suffixes aren't mandatory, if you skip them or don't provide enough it will use
+an auto generated suffix instead (`_00`).
+
+The sample image is part of a duty free asset pack from
+[kenney.nl](http://kenney.nl/).
+
+# About Rocket Pants
+![Rocket Pants](http://rocketpants.se/logo_xsmall.png)
+
+Rocket Pants is a small indie game studio based in Stockholm. If you like this
+tool please consider supporting us by checking out our games. Find out more at
+[rocketpants.se](http://rocketpants.se).
+
+# 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,27 @@
+task default: %w[run]
+
+task :run do
+  ruby '-I ./lib bin/slice_rename spec/fixtures/animals.png -c spec/fixtures/config_example.yml'
+end
+
+namespace :run do
+  task :debug do
+    ruby '-I ./lib bin/slice_rename --debug spec/fixtures/animals.png -c spec/fixtures/config_example.yml'
+  end
+
+  task :version do
+    ruby '-I ./lib bin/slice_rename --version'
+  end
+
+  task :help do
+    ruby '-I ./lib bin/slice_rename --help'
+  end
+
+  task :invalid do
+    ruby '-I ./lib bin/slice_rename --poop'
+  end
+
+  task :missing do
+    ruby '-I ./lib bin/slice_rename'
+  end
+end

data/bin/guard

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/slice_rename

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'slice_rename'
+SliceRename::Cli.perform

data/lib/slice_rename/cli.rb

@@ -0,0 +1,52 @@
+require 'optparse'
+
+require 'slice_rename/config'
+require 'slice_rename/slicer'
+
+module SliceRename
+  class Cli
+    def self.perform
+      config = SliceRename::Config.new
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: file [options]"
+
+        opts.on("-c", "--config MANDATORY", "A YAML file that contains the slice and name configuration") do |v|
+          config.load v
+        end
+
+        opts.on("-d", "--debug", "Output debug info") do |v|
+          config.debug = true
+        end
+
+        opts.on("-v", "--version", "Display the version") do |v|
+          puts VERSION
+          exit
+        end
+
+        opts.on("-h", "--help", "Display this message") do |v|
+          puts opts
+          exit
+        end
+      end
+
+      begin parser.parse! ARGV
+      rescue OptionParser::InvalidOption => e
+        puts e
+        puts parser
+        exit 1
+      end
+
+      arguments = parser.order ARGV
+      if arguments.empty?
+        puts 'Please specify an input file name.'
+        puts parser
+        exit 1
+      else
+        config.path = arguments.first
+      end
+
+      SliceRename::Slicer.slice_image config
+    end
+  end
+end

data/lib/slice_rename/config.rb

@@ -0,0 +1,44 @@
+require 'yaml'
+
+module SliceRename
+  class Config
+    attr_accessor :path, :debug
+    attr_reader :rows, :columns, :width, :height, :padding
+
+    def initialize
+      @path = ''
+      @debug = false
+      @rows = 1
+      @columns = 1
+      @width = 16
+      @height = 16
+      @padding = 0
+      @suffixes = []
+    end
+
+    def load(config_path)
+      config = YAML::load_file(File.join(config_path)).fetch('slice_rename_config', {})
+
+      @rows = config.fetch('rows', @rows)
+      @columns = config.fetch('columns', @columns)
+      @width = config.fetch('width', @width)
+      @height = config.fetch('height', @height)
+      @padding = config.fetch('padding', @padding)
+      @suffixes = config.fetch('suffixes', @suffixes)
+    end
+
+    def suffixes
+      count = @rows * @columns
+
+      if @suffixes.count < count
+        @suffixes = []
+
+        for i in 0..(count - 1)
+          @suffixes[i] = "_%02d" % (i + 1)
+        end
+      end
+
+      @suffixes
+    end
+  end
+end

data/lib/slice_rename/slicer.rb

@@ -0,0 +1,47 @@
+require 'mini_magick'
+
+module SliceRename
+  class Slicer
+    def self.slice_image(config)
+
+      extension = File.extname config.path
+      name = File.basename config.path, extension
+      path = File.dirname config.path
+
+      i = 0
+      for y in 0..(config.rows - 1)
+        for x in 0..(config.columns - 1)
+          # Not sure why we need to reload the image each time.
+          image = open_image config.path
+
+          crop = "#{config.width}x#{config.height}+#{x * config.width + (x + 1) * config.padding}+#{y * config.height + (y + 1) * config.padding}"
+          output_name = "#{path}/#{name}#{config.suffixes[i]}#{extension}"
+
+          if config.debug
+            puts crop
+            puts output_name
+          end
+
+          save_slice image, output_name, crop
+
+          i += 1
+        end
+      end
+    end
+
+    private
+
+    def self.open_image(path)
+      MiniMagick::Image.open path
+    end
+
+    def self.save_slice(image, file_name, cropping)
+      image.combine_options do |c|
+        c.crop cropping
+        c.repage.+
+      end
+
+      image.write file_name
+    end
+  end
+end

data/lib/slice_rename.rb

@@ -0,0 +1,5 @@
+require 'slice_rename/cli'
+
+module SliceRename
+  VERSION = '0.3.0'
+end

data/slice_rename.gemspec

@@ -0,0 +1,19 @@
+$LOAD_PATH << File.expand_path("../lib", __FILE__)
+require 'slice_rename'
+
+Gem::Specification.new do |s|
+  s.name = 'slice_rename'
+  s.version = SliceRename::VERSION
+  s.executables << 'slice_rename'
+
+  s.authors = ['Zoee Silcock']
+  s.email = %q{mrzoee@gmail.com}
+  s.homepage = %q{https://github.com/rocketpants/slice_rename}
+  s.description = %q{Slice an image and give each slice a specific name.}
+  s.summary = %q{Slice an image and give each slice a specific name.}
+  s.licenses = ['MIT']
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/spec/fixtures/config_example.yml

@@ -0,0 +1,13 @@
+slice_rename_config:
+  rows: 2
+  columns: 3
+  width: 175
+  height: 175
+  padding: 2
+  suffixes:
+    - _elephant
+    - _giraffe
+    - _hippo
+    - _monkey
+    - _panda
+    - _rabbit

data/spec/slice_rename/config_spec.rb

@@ -0,0 +1,64 @@
+require 'yaml'
+require 'slice_rename/config'
+
+RSpec.describe SliceRename::Config do
+  let(:config) { SliceRename::Config.new }
+
+  describe '#load' do
+    let(:config_path) { 'path/to/my_awesome_config.yml' }
+
+    it 'loads the config file' do
+      expect(YAML).to receive(:load_file) { {} }
+      config.load config_path
+    end
+  end
+
+  describe '#suffixes' do
+    let!(:suffixes) { ['poop'] }
+
+    it 'returns the supplied suffixes if it has enough' do
+      config.instance_variable_set :@suffixes, suffixes
+      expect(config.suffixes).to eq suffixes
+    end
+
+    it 'returns an auto generated array if suffixes are missing' do
+      config.instance_variable_set :@rows, 2
+      config.instance_variable_set :@columns, 2
+      expect(config.suffixes).to eq ['_01', '_02', '_03', '_04']
+    end
+  end
+
+  describe 'fields' do
+    it 'exposes the input file path' do
+      expect(config.path).to be_a String
+    end
+
+    it 'exposes whether to display debug info' do
+      expect(config.debug).to eq false
+    end
+
+    it 'exposes the number of rows' do
+      expect(config.rows).to be_an Integer
+    end
+
+    it 'exposes the number of columns' do
+      expect(config.columns).to be_an Integer
+    end
+
+    it 'exposes the width of each slice' do
+      expect(config.width).to be_an Integer
+    end
+
+    it 'exposes the height of each slice' do
+      expect(config.height).to be_an Integer
+    end
+
+    it 'exposes the padding between slices' do
+      expect(config.padding).to be_an Integer
+    end
+
+    it 'exposes a list of suffixes for the resulting file names' do
+      expect(config.suffixes).to be_an Array
+    end
+  end
+end

data/spec/slice_rename/sanity_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe 'Sanity' do
+  it 'Agrees that true is truthy' do
+    expect(true).to be_truthy
+  end
+end

data/spec/slice_rename/slicer_spec.rb

@@ -0,0 +1,38 @@
+require 'slice_rename/slicer'
+
+RSpec.describe SliceRename::Slicer do
+  let(:image_double) { double(:image) }
+  let(:config) { SliceRename::Config.new }
+  let(:suffixes) {
+    [
+      'potatoes',
+      'carrots',
+      'onions',
+      'selery'
+    ]
+  }
+
+  before do
+    config.instance_variable_set :@rows, 2
+    config.instance_variable_set :@columns, 2
+    config.instance_variable_set :@suffixes, suffixes
+    allow(SliceRename::Slicer).to receive(:open_image) { image_double }
+  end
+
+  describe '.slice_image' do
+    it 'saves the slices with the correct suffixes' do
+      call_count = 0
+      expect(SliceRename::Slicer).to(
+        receive(:save_slice).exactly(4).times do |image, name, cropping|
+          expect(image).to eq(image)
+          expect(name).to include suffixes[call_count]
+          # Should probably test the cropping logic somehow also.
+
+          call_count += 1
+        end
+      )
+
+      SliceRename::Slicer.slice_image config
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: slice_rename
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Zoee Silcock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-18 00:00:00.000000000 Z
+dependencies: []
+description: Slice an image and give each slice a specific name.
+email: mrzoee@gmail.com
+executables:
+- slice_rename
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/guard
+- bin/rspec
+- bin/slice_rename
+- lib/slice_rename.rb
+- lib/slice_rename/cli.rb
+- lib/slice_rename/config.rb
+- lib/slice_rename/slicer.rb
+- slice_rename.gemspec
+- spec/fixtures/animals.png
+- spec/fixtures/config_example.yml
+- spec/slice_rename/config_spec.rb
+- spec/slice_rename/sanity_spec.rb
+- spec/slice_rename/slicer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rocketpants/slice_rename
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Slice an image and give each slice a specific name.
+test_files: []