crop_pokemori_prof_image 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2d689afc178ce4a113930ab7e5d8c63110083d9
+  data.tar.gz: 247e9ff7400314a580db62a82acbc24b4ede028e
+SHA512:
+  metadata.gz: bdcc90f65c63933afbf6ded68182c2769da7ee459fc6f5effc56aad0262241d57196be3e9756d73f4a006c81043ad4593ca1135dff65c96a327c955381344346
+  data.tar.gz: 204382460bf73c30ea14a51244994de2a4761c46ae3a0703fc9515847cfaa5c549070199b1198ba7c872af7b3f11780da8b6808e16d48a38edd9fae5dcc5025b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in crop_pokemori_prof_image.gemspec
+gemspec
+
+gem 'rmagick'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    crop_pokemori_prof_image (0.1.0)
+      rmagick
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rmagick (2.16.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  crop_pokemori_prof_image!
+  rake (~> 10.0)
+  rmagick
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Osamu Takiya
+
+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,105 @@
+[![CircleCI](https://circleci.com/gh/corselia/crop-pokemori-prof-image/tree/master.svg?style=svg)](https://circleci.com/gh/corselia/crop-pokemori-prof-image/tree/master)
+
+# Overview
+- you can crop the profile image of [`Doubutsu-No-Mori Pocket Camp` (Animal Crossing Pocket Camp)](https://ac-pocketcamp.com/)
+    - first step
+        - you prepare the profile image file(s) of `Doubutsu-No-Mori Pocket Camp` (Animal Crossing Pocket Camp)
+    - second step
+        - exec method in this gem
+    - third step
+        - you get the devided image files, be happy :)
+
+# Installation
+```ruby
+$ gem install crop_pokemori_prof_image
+```
+
+# Usage
+
+#### 1. prepare the image file(s)
+- prepare the profile image file(s) of `Doubutsu-No-Mori Pocket Camp` (Animal Crossing Pocket Camp) like below
+
+![the_profile_image_files.png](the_profile_image_files.png "the_profile_image_files.png")
+
+#### 2. require gem
+```ruby
+require 'crop_pokemori_prof_image'
+```
+
+#### 3. exec method
+
+##### 3-1. `crop_single_image` method
+- `crop_single_image` method is for only one image file
+- `crop_single_image` method takes two arguments
+    - the first argument
+        - the image file name
+    - the second argument
+        - the output directory name
+        - optional
+        - the default value is 'crop_image'
+
+##### 3-2. `crop_multiple_image` method
+- `crop_multiple_image` method is for multiple image files
+- `crop_multiple_image` method takes two arguments
+    - the first argument
+        - the directory name which contains the image files
+        - optional
+        - the default value is '.'
+    - the second argument
+        - the output directory name
+        - optional
+        - the default value is 'crop_image'
+
+#### 4. 🎉you can get the crop image files🎉
+- after exec method, you can get the crop image files
+- you can get four part files per one source file
+    - 1. face
+        - naming format is `SOURCE_FILENAME_WITHOUT_EXT`_face.`EXT`
+    - 2. name
+        - naming format is `SOURCE_FILENAME_WITHOUT_EXT`_name.`EXT`
+    - 3. id number without 'ID' notation
+        - naming format is `SOURCE_FILENAME_WITHOUT_EXT`_id_number.`EXT`
+    - 4. id number with 'ID' notation
+        - naming format is `SOURCE_FILENAME_WITHOUT_EXT`_whole_id_part.`EXT`
+
+# Example
+
+#### when the source file is `sample.jpg`
+- `sample.jpg` is below
+
+![sample.jpg](sample.jpg "sample.jpg")
+
+#### the output four files are below
+- note: the image with Gaussian blur for privacy
+
+##### face (sample_face.jpg)
+![sample_face.jpg](crop_image/sample_face.jpg "sample_face.jpg")
+
+##### name (sample_name.jpg)
+![sample_name.jpg](crop_image/sample_name.jpg "sample_name.jpg")
+
+##### id number without 'ID' notation (sample_id_number.jpg)
+![sample_id_number.jpg](crop_image/sample_id_number.jpg "sample_id_number.jpg")
+
+##### id number with 'ID' notation (sample_whole_id_part.jpg)
+![sample_whole_id_part.jpg](crop_image/sample_whole_id_part.jpg "sample_whole_id_part.jpg")
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/corselia/crop-pokemori-prof-image.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TOO BAD! BAD! BAD!
+- Test codes aren't written!
+- if the source file's resolution isn't 16 vs 9, this app doesn't work correctly...
+    - for instance, iOS resolution
+    - for instance, pre-crop the image file by player

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crop_pokemori_prof_image"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/crop_pokemori_prof_image.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "crop_pokemori_prof_image/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "crop_pokemori_prof_image"
+  spec.version       = CropPokemoriProfImage::VERSION
+  spec.authors       = ["Osamu Takiya"]
+  spec.email         = ["takiya@toran.sakura.ne.jp"]
+
+  spec.summary       = %q{crop the prof image of 'Doubutsu-No-Mori Pocket Camp' (Animal Crossing Pocket Camp)}
+  spec.description   = %q{crop the captured profile image of 'Doubutsu-No-Mori Pocket Camp' and divide it to 'face', 'name' and 'id' images}
+  spec.homepage      = "https://github.com/corselia/crop-pokemori-prof-image"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'rmagick'
+end

data/lib/crop_pokemori_prof_image.rb

@@ -0,0 +1,29 @@
+require "crop_pokemori_prof_image/version"
+require 'crop_pokemori_prof_image/create_crop_image'
+require 'crop_pokemori_prof_image/is_pokemori_prof_image'
+
+module CropPokemoriProfImage
+  extend self
+  extend CreateCropImage
+  extend IsPokemoriProfImage
+
+  def crop_single_image(image_file, output_directory='crop_image')
+    image_file = change_to_fullpath(image_file)
+    @output_directory = output_directory
+
+    crop_image_initialize(image_file)
+    create_crop_image(image_file) if pokemori_prof_image?(@normalize_image_file)
+    remove_image_file(@normalize_image_file)
+  end
+
+  def crop_multiple_image(input_directory='.', output_directory='crop_image')
+    image_files = Pathname.glob("#{change_to_fullpath(input_directory)}/*").select do |filename|
+       filename.to_s =~ /\A.*(\.jpg|\.png)\z/
+    end
+    @output_directory = output_directory
+
+    image_files.each do |image_file|
+      crop_single_image(image_file.to_s, output_directory)
+    end
+  end
+end

data/lib/crop_pokemori_prof_image/create_crop_image.rb

@@ -0,0 +1,69 @@
+require 'crop_pokemori_prof_image/file_operation'
+
+module CreateCropImage
+  include FileOperation
+
+  RESIZE_TO                 = '720x1280'
+  FACE_CROP_AREA            = '130x130+295+320'
+  NAME_CROP_AREA            = '125x40+300+465'
+  ID_NUMBER_CROP_AREA       = '225x35+275+505'
+  WHOLE_ID_PART_CROP_AREA   = '280x35+220+505'
+
+  def create_crop_image(image_file)
+    crop_face
+    crop_name
+    crop_id_number
+    crop_whole_id_part
+  end
+
+  def crop_image_initialize(image_file) # image_file is full path
+    @image_file             = image_file
+    @basename_of_image_file = basename_of_image_file(image_file)
+    @extesion_of_basename   = File.extname(image_file)
+
+    make_directory_if_not_exist(@output_directory)
+    @normalize_image_file   = normalize_image_file
+  end
+
+  def normalize_image_file
+    source_image_file     = change_to_fullpath("#{File.dirname(@image_file)}/#{@basename_of_image_file}#{@extesion_of_basename}")
+    normalize_image_file  = change_to_fullpath("#{@output_directory}/#{@basename_of_image_file}_normalize#{@extesion_of_basename}")
+
+    command = "convert #{source_image_file} -resize #{RESIZE_TO} #{normalize_image_file}"
+    `#{command}`
+
+    normalize_image_file
+  end
+
+  def crop_face
+    crop_face_file = change_to_fullpath("#{@output_directory}/#{@basename_of_image_file}_face#{@extesion_of_basename}")
+    command = "convert #{@normalize_image_file} -crop #{FACE_CROP_AREA} #{crop_face_file}"
+    `#{command}`
+
+    crop_face_file
+  end
+
+  def crop_name
+    crop_name_file = change_to_fullpath("#{@output_directory}/#{@basename_of_image_file}_name#{@extesion_of_basename}")
+    command = "convert #{@normalize_image_file} -crop #{NAME_CROP_AREA} #{crop_name_file}"
+    `#{command}`
+
+    crop_name_file
+  end
+
+  def crop_id_number
+    crop_id_number_file = change_to_fullpath("#{@output_directory}/#{@basename_of_image_file}_id_number#{@extesion_of_basename}")
+    command = "convert #{@normalize_image_file} -crop #{ID_NUMBER_CROP_AREA} #{crop_id_number_file}"
+    `#{command}`
+
+    crop_id_number_file
+  end
+
+  def crop_whole_id_part
+    crop_whole_id_part_file = change_to_fullpath("#{@output_directory}/#{@basename_of_image_file}_whole_id_part#{@extesion_of_basename}")
+    command = "convert #{@normalize_image_file} -crop #{WHOLE_ID_PART_CROP_AREA} #{crop_whole_id_part_file}"
+    `#{command}`
+
+    crop_whole_id_part_file
+  end
+end

data/lib/crop_pokemori_prof_image/file_operation.rb

@@ -0,0 +1,24 @@
+require 'pathname'
+
+module FileOperation
+  def make_directory_if_not_exist(directory)
+    directory = Pathname.new(change_to_fullpath(directory)).to_s
+    unless File.exists?(directory)
+      command = "mkdir #{directory}"
+      `#{command}`
+    end
+    directory
+  end
+
+  def basename_of_image_file(image_file)
+    File.basename(image_file, '.*')
+  end
+
+  def remove_image_file(filename)
+    File.delete(filename)
+  end
+
+  def change_to_fullpath(filename)
+    Pathname.new(Dir.pwd).join(filename).to_s
+  end
+end

data/lib/crop_pokemori_prof_image/is_pokemori_prof_image.rb

@@ -0,0 +1,93 @@
+require 'rmagick'
+
+module IsPokemoriProfImage
+  include Magick
+
+  AREA_START_X = 200
+  AREA_START_Y = 1050
+  AREA_END_X   = 680
+  AREA_END_Y   = 1150
+
+  RGB_COLOR = [
+    'red',
+    'green',
+    'blue',
+  ].freeze
+
+  EXPECTED_PIXEL_MIN_BRIGHTNESS = {
+    red:    80 * 256,
+    green:  180 * 256,
+    blue:   160 * 256,
+  }.freeze
+
+  EXPECTED_PIXEL_MAX_BRIGHTNESS = {
+    red:    100 * 256,
+    green:  200 * 256,
+    blue:   180 * 256,
+  }.freeze
+
+  # HACK: image_file must be halfHD size
+  def pokemori_prof_image?(image_file)
+    image_object = ImageList.new(image_file)
+
+    # HACK: NOT DRY
+    result = []
+    result << image_size_invalid?(image_object)
+    result << init_pixel_brightness_valid?(image_object)
+    result << judge_area_pixel_brightness_valid?(image_object)
+
+    !(result.include?(false)) # HACK: double negative
+  end
+
+  private
+  def image_object(image_file)
+    ImageList.new(image_file)
+  end
+
+  def image_size_invalid?(image_object)
+    unless image_object.columns == 720 || image_object.rows == 1280 # HACK: must be half HD size
+      return false
+    end
+    true
+  end
+
+  def pixel_brightness(image_object, x, y)
+    {
+      red:    image_object.pixel_color(x, y).red,
+      green:  image_object.pixel_color(x, y).green,
+      blue:   image_object.pixel_color(x, y).blue,
+    }
+  end
+
+  # if 'the color of all pixels in search area' is equal to 'the color of initial position pixel', it is true
+  def judge_area_pixel_brightness_valid?(image_object)
+    for x in AREA_START_X...AREA_END_X
+      for y in AREA_START_Y...AREA_END_Y
+        RGB_COLOR.each do |color|
+          unless pixel_brightness(image_object, x, y)[color] == init_pixel_brightness(image_object)[color]
+            return false
+          end
+        end
+      end
+    end
+    true
+  end
+
+  # if 'the color of initial position pixel' is within the range of specified, it is true
+  def init_pixel_brightness_valid?(image_object)
+    init_pixel_brightness(image_object).each do |origin_color, brightness|
+      if brightness < EXPECTED_PIXEL_MIN_BRIGHTNESS[origin_color] || EXPECTED_PIXEL_MAX_BRIGHTNESS[origin_color] < brightness
+        return false
+      end
+    end
+    true
+  end
+
+  def init_pixel_brightness(image_object)
+    {
+      red:    image_object.pixel_color(AREA_START_X, AREA_START_Y).red,
+      green:  image_object.pixel_color(AREA_START_X, AREA_START_Y).green,
+      blue:   image_object.pixel_color(AREA_START_X, AREA_START_Y).blue,
+    }
+  end
+end

data/lib/crop_pokemori_prof_image/version.rb

@@ -0,0 +1,3 @@
+module CropPokemoriProfImage
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: crop_pokemori_prof_image
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Osamu Takiya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: crop the captured profile image of 'Doubutsu-No-Mori Pocket Camp' and
+  divide it to 'face', 'name' and 'id' images
+email:
+- takiya@toran.sakura.ne.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crop_image/sample_face.jpg
+- crop_image/sample_id_number.jpg
+- crop_image/sample_name.jpg
+- crop_image/sample_whole_id_part.jpg
+- crop_pokemori_prof_image.gemspec
+- lib/crop_pokemori_prof_image.rb
+- lib/crop_pokemori_prof_image/create_crop_image.rb
+- lib/crop_pokemori_prof_image/file_operation.rb
+- lib/crop_pokemori_prof_image/is_pokemori_prof_image.rb
+- lib/crop_pokemori_prof_image/version.rb
+- sample.jpg
+- the_profile_image_files.png
+homepage: https://github.com/corselia/crop-pokemori-prof-image
+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.6.13
+signing_key: 
+specification_version: 4
+summary: crop the prof image of 'Doubutsu-No-Mori Pocket Camp' (Animal Crossing Pocket
+  Camp)
+test_files: []