has_placeholder_image 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6ff5f16da8449225f6d79715b19a076995be630580359e16006894048a0dc17
+  data.tar.gz: 7368e88ab1b04045d2ad2193266212fe17581034cd89871645b8f0787a50d2f1
+SHA512:
+  metadata.gz: d3cbd3018eba18812ba1d0c18bf9efbafeca5583c283298088b2d9797bfd4eb8136774e2b1149c2fe7e410d51cc8ab27da352000753ac06d74ecfdf806d4b9e8
+  data.tar.gz: 05fa8285da159042181f8e0f606a924f5210ec26519c6b8f1ed165d5048c00c502542c070cbee1c3d46b315d575f8af5e28c244034239e50d3b29ffa117afade

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Muhammet Dilmaç
+
+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,95 @@
+# HasPlaceholderImage
+![Test](https://github.com/buck-ai/has-placeholder-image/workflows/Test/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d7ff2ca5f9ceb238c353/maintainability)](https://codeclimate.com/github/buck-ai/has_placeholder_image/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d7ff2ca5f9ceb238c353/test_coverage)](https://codeclimate.com/github/buck-ai/has_placeholder_image/test_coverage)
+
+
+Has Placeholder Image is a Ruby on Rails gem that allows developers to generate placeholder images for models depending on the title or name attributes of model.
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'has_placeholder_image'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install has_placeholder_image
+```
+
+after generate configuration file with this command;
+```shell script
+rails g has_placeholder_image:install
+```
+
+## Usage
+Insert this method to your model which will have placeholder images:
+ 
+ `has_placeholder_image`
+
+You can customize default configuration with `config/initializers/has_placeholder_image.rb` or you can customize placeholder image generation on model basis by adding custom attributes to placeholder callback.
+
+For example;
+```ruby
+has_placeholder_image source: :title, 
+                      target: :logo, 
+                      background_color: '#335eea'
+```
+
+## Configuration
+
+The default configuration lies in `config/initializers/has_placeholder_image.rb` and can be customized according to your liking.
+
+```ruby
+HasPlaceholderImage.setup do |config|
+  config.background_color = '#000000'
+  config.font_color = '#FFFFFF'
+  config.font_size = 200
+  config.transformer = 'two_word_first_letter_upcase'
+  config.source = 'name'
+  config.target = 'photo'
+  config.output_path = Rails.root.join('tmp/placeholders')
+  config.height = 300
+  config.width = 300
+end
+```
+
+| Key | Description |
+| --- | ----------- |
+| `background_color` | For image background color. |
+| `font_color` | For text color. |
+| `font_size` | For font size. |
+| `transformer` | How to generate your image title. This time only have `'two_word_first_letter_upcase'` method. |
+| `source` | Placeholder image text generate with this field. |
+| `target` | Your active storage attribute on your model. |
+| `output_path` | Where to store generated images path. |
+| `height` | Generated image height. |
+| `width` | Generated image width. |
+
+## Example
+app/models/company.rb
+```ruby
+# frozen_string_literal: true
+
+class Company < ApplicationRecord
+  has_one_attached :logo
+  has_placeholder_image source: :title, target: :logo,
+                        background_color: '#335eea',
+			            font_size: 200
+
+  validates :title, presence: true
+end
+```
+![Output](docs/example.png)
+
+
+## Contributing
+See the contributing guide.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasPlaceholderImage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/has_placeholder_image/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module HasPlaceholderImage
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates a Has Placeholder Image initializer to your application.'
+
+      def copy_initializer
+        template 'has_placeholder_image.rb', 'config/initializers/has_placeholder_image.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/has_placeholder_image.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+HasPlaceholderImage.setup do |config|
+  config.background_color = '#000000'
+  config.font_color = '#FFFFFF'
+  config.font_size = 200
+  config.transformer = 'two_word_first_letter_upcase'
+  config.source = 'name'
+  config.target = 'photo'
+  config.output_path = Rails.root.join('tmp/placeholders')
+  config.height = 300
+  config.width = 300
+end

data/lib/has_placeholder_image.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# HasPlaceholderImage Plugin
+module HasPlaceholderImage
+  autoload :ActiveRecord,   'has_placeholder_image/active_record'
+  autoload :TextGenerator,  'has_placeholder_image/text_generator'
+  autoload :ImageGenerator, 'has_placeholder_image/image_generator'
+
+  mattr_accessor :background_color
+  @background_color = '#000000'
+
+  mattr_accessor :font_color
+  @font_color = :'#FFFFFF'
+
+  mattr_accessor :font_size
+  @font_size = 50
+
+  mattr_accessor :transformer
+  @transformer = 'two_word_first_letter_upcase'
+
+  mattr_accessor :source
+  @source = :name
+
+  mattr_accessor :target
+  @target = :photo
+
+  mattr_accessor :output_path
+  @output_path = 'tmp/placeholders'
+
+  mattr_accessor :height
+  @height = 300
+
+  mattr_accessor :width
+  @width = 300
+
+  def self.default_options
+    variables = {}
+
+    class_variables.each do |variable|
+      variable_name = variable.to_s.delete('@').to_sym
+      variables[variable_name] = class_variable_get(variable)
+    end
+
+    variables
+  end
+
+  def self.setup
+    yield self
+  end
+end
+
+require 'has_placeholder_image/railtie'

data/lib/has_placeholder_image/active_record.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module HasPlaceholderImage
+  module ActiveRecord
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_placeholder_image(**options)
+        default_options = HasPlaceholderImage.default_options
+        merged_options = default_options.update(options)
+
+        mattr_accessor :placeholder_image_options
+        self.placeholder_image_options = merged_options
+
+        after_validation :generate_placeholder_image, if: :need_placeholder?
+
+        include HasPlaceholderImage::ActiveRecord::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      private
+
+      def generate_placeholder_image
+        options = self.class.placeholder_image_options
+        text = HasPlaceholderImage::TextGenerator.send(options[:transformer],
+                                                       @placeholder_image_source)
+        image = HasPlaceholderImage::ImageGenerator.new(text, **options)
+
+        @placeholder_image_target.attach(io: File.open(image.file), filename: File.basename(image.file))
+      end
+
+      def need_placeholder?
+        @placeholder_image_target = send(self.class.placeholder_image_options[:target])
+        @placeholder_image_source = send(self.class.placeholder_image_options[:source])
+
+        !@placeholder_image_target.attached? && !@placeholder_image_source.blank?
+      end
+    end
+  end
+end

data/lib/has_placeholder_image/image_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rmagick'
+
+module HasPlaceholderImage
+  class ImageGenerator
+    attr_reader :options, :canvas, :draw, :file, :text
+
+    def initialize(text, **params)
+      @options = params
+      @text = text
+      return if exist?
+
+      generate_canvas
+      generate_draw
+      generate_result
+    end
+
+    private
+
+    def exist?
+      base_folder = ::Rails.root.join(@options[:output_path])
+      size_folder = base_folder.join("#{@options[:height]}x#{@options[:width]}")
+      font_folder = size_folder.join((@options[:font_size]).to_s)
+      file_name = "bg_#{@options[:background_color]}-cl_#{@options[:font_color]}-#{@text}.png"
+      @file = font_folder.join(file_name)
+
+      File.exist?(@file)
+    end
+
+    def generate_canvas
+      @canvas = ::Magick::Image.new(@options[:height], @options[:width])
+      @canvas.color_reset!(@options[:background_color])
+    end
+
+    def generate_draw
+      @draw = ::Magick::Draw.new
+      @draw.pointsize = @options[:font_size]
+      @draw.fill = @options[:font_color]
+      @draw.gravity = ::Magick::CenterGravity
+      @draw.annotate(@canvas, 0, 0, 0, 0, @text)
+    end
+
+    def generate_result
+      FileUtils.mkdir_p(File.dirname(@file))
+      @canvas.write(@file)
+    end
+  end
+end

data/lib/has_placeholder_image/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_record/railtie'
+
+module HasPlaceholderImage
+  class Railtie < ::Rails::Railtie
+    initializer 'has_placeholder_image.initialize' do |app|
+      railtie_collection = app.railties
+      activerecord_railtie = railtie_collection.select { |railtie| railtie.class.to_s == 'ActiveRecord::Railtie' }
+      ::ActiveRecord::Base.include(HasPlaceholderImage::ActiveRecord) if activerecord_railtie
+    end
+  end
+end

data/lib/has_placeholder_image/text_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module HasPlaceholderImage
+  # Text generation methods
+  module TextGenerator
+    # This method take text field and parse with delimiter and take first word_count number word
+    # first letter upcase
+    def self.two_word_first_letter_upcase(value, delimiter: ' ', word_count: 2)
+      value.split(delimiter)
+           .first(word_count)
+           .map(&:first)
+           .join
+           .upcase
+    end
+  end
+end

data/lib/has_placeholder_image/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HasPlaceholderImage
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: has_placeholder_image
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muhammet Dilmaç
+- Utku Kaynar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: sqlite3
+  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'
+description: Has Placeholder Image is a Ruby on Rails gem that allows developers to
+  generate placeholder images for models depending on the title or name attributes
+  of model.
+email:
+- iletisim@muhammetdilmac.com.tr
+- utku@buck.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/has_placeholder_image/install_generator.rb
+- lib/generators/templates/has_placeholder_image.rb
+- lib/has_placeholder_image.rb
+- lib/has_placeholder_image/active_record.rb
+- lib/has_placeholder_image/image_generator.rb
+- lib/has_placeholder_image/railtie.rb
+- lib/has_placeholder_image/text_generator.rb
+- lib/has_placeholder_image/version.rb
+homepage: https://www.github.com/buck-ai/has-placeholder-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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A Ruby gem for generating string based placeholder images in Rails.
+test_files: []