rpictogrify 0.1.0

data/lib/rpictogrify/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rpictogrify
+  class Configuration
+    # default theme, one of these themes: avataars_female, avataars_male, male_flat, monsters. default is :monsters
+    attr_accessor :theme
+
+    # pictogram directory. default is 'public/system'
+    attr_accessor :base_path
+
+    def initialize
+      @theme = :monsters
+
+      @base_path = 'public/system'
+    end
+  end
+end

data/lib/rpictogrify/generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rpictogrify/pictogram'
+
+module Rpictogrify
+  module Generator
+    extend self
+
+    # example
+    #   Rpictogrify::Generator.call 'jim', theme: :avataars_male
+    def call(text, options = {})
+      pictogram = Rpictogrify::Pictogram.new(text, options)
+      pictogram.generate
+    end
+  end
+end

data/lib/rpictogrify/inflector.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Rpictogrify
+  module Inflector
+    extend self
+
+    def underscore(camel_cased_word)
+      return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+      word = camel_cased_word.to_s.gsub("::", "/")
+      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
+      word.downcase!
+      word
+    end
+
+    def camelize(term, uppercase_first_letter = true)
+      if uppercase_first_letter
+        term = term.sub(/^[a-z\d]*/) { |match| match.capitalize }
+      else
+        term = term.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+      end
+      term.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+    end
+  end
+end

data/lib/rpictogrify/pictogram.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'rpictogrify/theme'
+
+module Rpictogrify
+  class Pictogram
+    # BUMP UP if avatar algorithm changes
+    VERSION = 1
+
+    attr_reader :text, :options, :theme, :uid
+
+    def initialize(text, options = {})
+      @text    = text.to_s
+      @options = options
+      @theme   = Rpictogrify::Theme.find(options[:theme] || Rpictogrify.config.theme)
+      @uid     = generate_uid
+    end
+
+    def generate
+      File.write(path, svg) unless File.exist?(path)
+      path
+    end
+
+    def svg
+      includes = symbols.map do |shape, symbol|
+        fillable = fill[shape] ? "fill='#{fill[shape]}'" : ''
+        "<svg class='#{shape}' #{fillable} xmlns='http://www.w3.org/2000/svg'>#{symbol}</svg>"
+      end
+
+      <<-XML.strip
+        <svg viewBox="0 0 #{size} #{size}" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+          <g>
+            <rect fill="#{colors['background']}" x="0" y="0" width="#{size}" height="#{size}"></rect>
+            #{includes.join("\n")}
+          </g>
+        </svg>
+      XML
+    end
+
+    def base64
+      "data:image/svg+xml;base64,#{Base64.encode64(svg)[0...-1]}"
+    end
+
+    def size
+      @size ||= theme.width || 300
+    end
+
+    def path
+      @path ||= begin
+        dir = File.join(self.class.base_path, theme.ident)
+        FileUtils.mkdir_p(dir)
+
+        File.join(dir, "#{[text, uid].join('-')}.svg")
+      end
+    end
+
+    class << self
+      def base_path
+        File.join (Rpictogrify.config.base_path || 'public/system'), 'rpictogrify', "#{VERSION}"
+      end
+    end
+
+    private
+
+    def generate_uid
+      text.hash.abs.to_s.gsub('0', '1')
+    end
+
+    def shapes
+      @shapes ||= theme.shapes.each_with_index.inject({}) do |result, ((shape, value), index)|
+        result[shape] = uid[index].nil? || uid[index].to_i > value['length'] ? '01' : uid[index].rjust(2, '0')
+        result
+      end
+    end
+
+    def colors
+      @colors ||= theme.colors.each_with_index.inject({}) do |result, ((part, values), index)|
+        result[part] = values[uid[index].to_i] || values.first
+        result
+      end
+    end
+
+    def fill
+      @fill ||= theme.shapes.inject({}) do |result, (shape, value)|
+        color = colors[value['fill']]
+        result[shape] = color if color
+        result
+      end
+    end
+
+    def symbols
+      @symbols ||= shapes.inject({}) do |result, (shape, value)|
+        symbol = theme.symbol("#{shape}-#{value}")
+        result[shape] = symbol&.children.to_s.gsub('\n', '')
+        result
+      end
+    end
+  end
+end

data/lib/rpictogrify/theme.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rpictogrify/themes/base'
+require 'rpictogrify/themes/avataars_female'
+require 'rpictogrify/themes/avataars_male'
+require 'rpictogrify/themes/male_flat'
+require 'rpictogrify/themes/monsters'
+
+module Rpictogrify
+  class Theme
+    class << self
+      def find(ident)
+        theme_name = Rpictogrify::Inflector.camelize(ident.to_s)
+        Object.const_get("Rpictogrify::Themes::#{theme_name}")
+      rescue NameError
+        raise ArgumentError.new('The ident argument must be one of themes: avataars_female, avataars_male, male_flat, monsters')
+      end
+    end
+  end
+end

data/lib/rpictogrify/themes/avataars_female.rb

@@ -0,0 +1,6 @@
+module Rpictogrify
+  module Themes
+    class AvataarsFemale < Base
+    end
+  end
+end

data/lib/rpictogrify/themes/avataars_male.rb

@@ -0,0 +1,6 @@
+module Rpictogrify
+  module Themes
+    class AvataarsMale < Base
+    end
+  end
+end

data/lib/rpictogrify/themes/base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'singleton'
+require 'json'
+
+module Rpictogrify
+  module Themes
+    class Base
+      include Singleton
+      extend SingleForwardable
+
+      attr_reader :mapping, :resource, :ident
+      def_delegators :instance, :mapping, :resource, :ident,
+                                :width, :height, :shapes, :colors, :symbol
+
+      def initialize
+        @ident    = get_ident
+        @mapping  = parse_mapping
+        @resource = parse_resource
+      end
+
+      def width
+        view_box[2]
+      end
+
+      def height
+        view_box[3]
+      end
+
+      def shapes
+        mapping['shapes']
+      end
+
+      def colors
+        mapping['colors']
+      end
+
+      def symbol(id)
+        resource.at_xpath("//*[@id='#{id}']")
+      end
+
+      private
+
+      def get_ident
+        Rpictogrify::Inflector.underscore(self.class.name).split('/').last
+      end
+
+      def parse_mapping
+        JSON.parse File.read(Rpictogrify.themes_assets_path.join(ident, 'mapping.json'))
+      end
+
+      def parse_resource
+        Nokogiri.XML File.read(Rpictogrify.themes_assets_path.join(ident, 'resource.svg'))
+      end
+
+      def view_box
+        @view_box ||= mapping['viewBox'].split(' ')
+      end
+    end
+  end
+end

data/lib/rpictogrify/themes/male_flat.rb

@@ -0,0 +1,6 @@
+module Rpictogrify
+  module Themes
+    class MaleFlat < Base
+    end
+  end
+end

data/lib/rpictogrify/themes/monsters.rb

@@ -0,0 +1,6 @@
+module Rpictogrify
+  module Themes
+    class Monsters < Base
+    end
+  end
+end

data/lib/rpictogrify/version.rb

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

data/spec/rpictogrify_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'rpictogrify'
+
+describe Rpictogrify do
+  context 'configure' do
+    it 'load default config' do
+      expect(Rpictogrify.config.theme).to eq(:monsters)
+      expect(Rpictogrify.config.base_path).to eq('public/system')
+    end
+
+    it 'change after configure' do
+      Rpictogrify.configure do
+        self.theme     = :avataars_female
+        self.base_path = 'public'
+      end
+
+      expect(Rpictogrify.config.theme).to eq(:avataars_female)
+      expect(Rpictogrify.config.base_path).to eq('public')
+
+      Rpictogrify.configure do
+        self.theme     = :monsters
+        self.base_path = 'public/system'
+      end
+    end
+  end
+
+  context 'generate' do
+    it 'return pictogram path with default theme' do
+      path = Rpictogrify.generate 'jim.cheung'
+      expect(path).to include('monsters')
+    end
+
+    it 'return pictogram path with given theme' do
+      path = Rpictogrify.generate 'jim.cheung', theme: :avataars_female
+      expect(path).to include('avataars_female')
+    end
+
+    it 'return pictogram path with changed configuration' do
+      Rpictogrify.configure do
+        self.theme     = :avataars_female
+        self.base_path = 'public/custom'
+      end
+
+      path = Rpictogrify.generate 'jim.cheung'
+      expect(path).to include('avataars_female')
+      expect(path).to include('public/custom')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# 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.
+#
+# 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
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows 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. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # 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,97 @@
+--- !ruby/object:Gem::Specification
+name: rpictogrify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Cheung
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
+email:
+- hi.jinhu.zhang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- assets/themes/avataars_female/mapping.json
+- assets/themes/avataars_female/resource.svg
+- assets/themes/avataars_male/mapping.json
+- assets/themes/avataars_male/resource.svg
+- assets/themes/male_flat/mapping.json
+- assets/themes/male_flat/resource.svg
+- assets/themes/monsters/mapping.json
+- assets/themes/monsters/resource.svg
+- lib/rpictogrify.rb
+- lib/rpictogrify/configuration.rb
+- lib/rpictogrify/generator.rb
+- lib/rpictogrify/inflector.rb
+- lib/rpictogrify/pictogram.rb
+- lib/rpictogrify/theme.rb
+- lib/rpictogrify/themes/avataars_female.rb
+- lib/rpictogrify/themes/avataars_male.rb
+- lib/rpictogrify/themes/base.rb
+- lib/rpictogrify/themes/male_flat.rb
+- lib/rpictogrify/themes/monsters.rb
+- lib/rpictogrify/version.rb
+- spec/rpictogrify_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jinhucheung/rpictogrify
+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.8
+signing_key:
+specification_version: 4
+summary: Ruby version of the pictogrify to generate unique pictograms
+test_files:
+- spec/spec_helper.rb
+- spec/rpictogrify_spec.rb