rpictogrify 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98bfc90c4b65c31523c5fbb83597b1207ad6ff385e45103a563a4676d0ef2de6
-  data.tar.gz: a1d198f5390328ea67a5b1bcce2d6edb16f55e535a6e57e3b3ffc6a5fb86af64
+  metadata.gz: 16f8ae00a030fcb82258a5885dda4f0de316b4e1d3ea98c0c32369ad6baf0f7c
+  data.tar.gz: 000f34d1b9d95c2ab8eaec9b3da7b859c01e120efa8ec5c18b9b7dc2dcb9ccfc
 SHA512:
-  metadata.gz: 8e3d48f8b4ca2998ece98e9bcb122b0b50a530c3be917ad440a74f5f04f7cfd5c00e24f6df29df9a59600d34c46a393133de23d02793ddea64524299d6c2c00a
-  data.tar.gz: afd350e78cd39368f717b983ea4a88059015a7f01ba397b9c5e3d5e32df5b70b04840cbd7a776e941d2472ccb95cf44b1464b94aaebc81f6d2f62fff843697e2
+  metadata.gz: 07cb42697c11d430ac62712e15cc21f5d761b2150d04e63c4b6dc1c80d8e742c4e3298d3c07f68e285777741676db21db4b3446e3e744a1df6b547337bfd086b
+  data.tar.gz: 8cf24261df62a257b1648348c7d6103a21029ecb61321b28572ed7102b003dea3327a1ba02df719512e2d888cbe9034b127e4113c2d0de3680312df4fa470f52

data/README.md

@@ -36,14 +36,17 @@ Rpictogrify.configure do
   self.theme      = :monsters
   # pictogram directory. default is 'public/system'
   self.base_path  = 'public/system'
+  # register a custome theme with assets. assets see assets/themes
+  self.register_theme :custom, assets_path: 'vendor/assets/rpictogrify/themes/custom'
 end
 ```
 
 ## Usage
 
 ```ruby
-Rpictogrify.generate 'jim.cheung'                          #=> 'public/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg'
-Rpictogrify.generate 'jim.cheung', theme: :avataars_male   #=> 'public/system/rpictogrify/1/avataars_male/jim.cheung-2935966159678137421.svg'
+Rpictogrify.generate 'jim.cheung'                          #=> 'public/system/rpictogrify/1/monsters/1313467160.svg'
+Rpictogrify.generate 'jim.cheung', theme: :avataars_male   #=> 'public/system/rpictogrify/1/avataars_male/1313467160.svg'
+Rpictogrify.generate 'jim.cheung', theme: :custom          #=> 'public/system/rpictogrify/1/custom/1313467160.svg', use custom theme
 ```
 
 ### Controller / View
@@ -57,10 +60,10 @@ include Rpictogrify::Helper
 Then you can use the following methods in views.
 
 ```ruby
-rpictogrify_for('jim', theme: :monsters)          #=> 'public/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg'
-rpictogrify_url('jim')                            #=> '/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg'
-rpictogrify_tag('jim', html: {class: :avatar})    #=> '<img class="avatar" src="/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg" alt="jim" />'
-rpictogrify_url_for('public/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg') #=> '/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg'
+rpictogrify_for('jim', theme: :monsters)          #=> 'public/system/rpictogrify/1/monsters/1313467160.svg'
+rpictogrify_url('jim')                            #=> '/system/rpictogrify/1/monsters/1313467160.svg'
+rpictogrify_tag('jim', html: {class: :avatar})    #=> '<img class="avatar" src="/system/rpictogrify/1/monsters/1313467160.svg" alt="jim" />'
+rpictogrify_url_for('public/system/rpictogrify/1/monsters/1313467160.svg') #=> '/system/rpictogrify/1/monsters/1313467160.svg'
 ```
 
 ### Model
@@ -79,8 +82,8 @@ end
 Then you have the following methods in user
 
 ```ruby
-@user.rpictogrify_path      #=> 'public/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg'
-@user.rpictogrify_url       #=> '/system/rpictogrify/1/monsters/jim.cheung-1512422874962937463.svg'
+@user.rpictogrify_path      #=> 'public/system/rpictogrify/1/monsters/1313467160.svg'
+@user.rpictogrify_url       #=> '/system/rpictogrify/1/monsters/1313467160.svg'
 ```
 
 ## Contributing
@@ -96,4 +99,4 @@ Please write unit test with your code if necessary.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).
+The gem is available as open source under the terms of the [MIT License](MIT-LICENSE).

data/lib/rpictogrify/configuration.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rpictogrify/theme'
+
 module Rpictogrify
   class Configuration
     # default theme, one of these themes: avataars_female, avataars_male, male_flat, monsters. default is :monsters
@@ -13,5 +15,10 @@ module Rpictogrify
 
       @base_path = 'public/system'
     end
+
+    # register a custome theme with assets. assets see assets/themes.
+    def register_theme(ident, assets_path:)
+      Rpictogrify::Theme.register(ident, assets_path: assets_path)
+    end
   end
-end
+end

data/lib/rpictogrify/theme.rb

@@ -15,6 +15,23 @@ module Rpictogrify
       rescue NameError
         raise ArgumentError.new('The ident argument must be one of themes: avataars_female, avataars_male, male_flat, monsters')
       end
+
+      def register(ident, assets_path:)
+        define_class_context = ->(binding) do
+          @@assets_path = assets_path
+          def assets_path
+            Pathname.new(@@assets_path)
+          end
+        end
+
+        theme_name  = Rpictogrify::Inflector.camelize(ident.to_s)
+        theme_class = "Rpictogrify::Themes::#{theme_name}"
+        if Object.const_defined?(theme_class)
+          Object.const_get(theme_class).class_eval(&define_class_context)
+        else
+          Rpictogrify::Themes.const_set(theme_name, Class.new(Rpictogrify::Themes::Base, &define_class_context))
+        end
+      end
     end
   end
 end

data/lib/rpictogrify/themes/base.rb

@@ -10,14 +10,12 @@ module Rpictogrify
       include Singleton
       extend SingleForwardable
 
-      attr_reader :mapping, :resource, :ident
-      def_delegators :instance, :mapping, :resource, :ident,
+      attr_reader :mapping, :resource, :ident, :assets_path
+      def_delegators :instance, :mapping, :resource, :ident, :assets_path,
                                 :width, :height, :shapes, :colors, :symbol
 
       def initialize
-        @ident    = get_ident
-        @mapping  = parse_mapping
-        @resource = parse_resource
+        @ident = get_ident
       end
 
       def width
@@ -40,18 +38,22 @@ module Rpictogrify
         resource.at_xpath("//*[@id='#{id}']")
       end
 
-      private
+      def assets_path
+        Rpictogrify.themes_assets_path.join(ident)
+      end
 
-      def get_ident
-        Rpictogrify::Inflector.underscore(self.class.name).split('/').last
+      def mapping
+        @mapping ||= JSON.parse(File.read(assets_path.join('mapping.json')))
       end
 
-      def parse_mapping
-        JSON.parse File.read(Rpictogrify.themes_assets_path.join(ident, 'mapping.json'))
+      def resource
+        @resource ||= Nokogiri.XML(File.read(assets_path.join('resource.svg')))
       end
 
-      def parse_resource
-        Nokogiri.XML File.read(Rpictogrify.themes_assets_path.join(ident, 'resource.svg'))
+      private
+
+      def get_ident
+        Rpictogrify::Inflector.underscore(self.class.name).split('/').last
       end
 
       def view_box

data/lib/rpictogrify/version.rb

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

data/lib/rpictogrify.rb

@@ -24,6 +24,10 @@ module Rpictogrify
       @config ||= Configuration.new
     end
 
+    def reset_config
+      @config = nil
+    end
+
     def configure(&block)
       config.instance_exec(&block)
     end
@@ -44,4 +48,4 @@ module Rpictogrify
       path.to_s.sub('public/', '/')
     end
   end
-end
+end

data/spec/rpictogrify_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 require 'rpictogrify'
 
 describe Rpictogrify do
+  after do
+    Rpictogrify.reset_config
+  end
+
   context 'configure' do
     it 'load default config' do
       expect(Rpictogrify.config.theme).to eq(:monsters)
@@ -16,11 +20,27 @@ describe Rpictogrify do
 
       expect(Rpictogrify.config.theme).to eq(:avataars_female)
       expect(Rpictogrify.config.base_path).to eq('public')
+    end
+
+    it 'register theme' do
+      custom_theme_assets_path = 'vendor/assets/rpictogrify/themes/custom'
+      expect(defined?(Rpictogrify::Themes::Custom)).to be_falsy
+
+      Rpictogrify.configure do
+        self.theme     = :custom
+        self.register_theme :custom, assets_path: custom_theme_assets_path
+      end
+
+      expect(defined?(Rpictogrify::Themes::Custom)).to be_truthy
+      expect(Rpictogrify::Themes::Custom.superclass).to eq Rpictogrify::Themes::Base
+      expect(Rpictogrify::Themes::Custom.assets_path).to eq Pathname.new(custom_theme_assets_path)
+      expect(Rpictogrify.config.theme).to eq(:custom)
 
       Rpictogrify.configure do
-        self.theme     = :monsters
-        self.base_path = 'public/system'
+        self.register_theme :monsters, assets_path: Pathname.new(custom_theme_assets_path)
       end
+      expect(Rpictogrify::Themes::Monsters.assets_path).to eq Pathname.new(custom_theme_assets_path)
+      expect(Rpictogrify::Themes::Monsters.superclass).to eq Rpictogrify::Themes::Base
     end
   end
 
@@ -44,11 +64,15 @@ describe Rpictogrify do
       path = Rpictogrify.generate 'jim.cheung'
       expect(path).to include('avataars_female')
       expect(path).to include('public/custom')
+    end
 
+    it 'return pictogram path with custom theme' do
       Rpictogrify.configure do
-        self.theme     = :monsters
-        self.base_path = 'public/system'
+        self.register_theme :custom, assets_path: 'assets/themes/male_flat'
       end
+
+      path = Rpictogrify.generate 'jim.cheung', theme: :custom
+      expect(path).to include('custom')
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpictogrify
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jim Cheung
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2022-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -104,10 +104,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 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
+- spec/spec_helper.rb