rpictogrify 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9fc80fdfcac7707fd1a41b0ba12e25b8f1c2290417433f305772022cbbc61c5
-  data.tar.gz: c1ab1094c3392d322769580a5355a7d5a69c4c8ce4884c338e174ebe24e4ed80
+  metadata.gz: 3664e3a68fee566a6aaf97ca874adf0cf8b1a084dc73604ea9481ec3925a96b1
+  data.tar.gz: 68d39dc71dd312d76679d1e653ce76ecfd532a1c9db85c832504a2bf70eb144f
 SHA512:
-  metadata.gz: 611b151a621cb1255ea2abe3debae7152ba6ab6308b92d3b236fc93a2efe04d3497203661cc8b53c6844a57192577b298e5714e6bf6fccd79e464a14189addc6
-  data.tar.gz: 6865400755633cf561f26b09e25781dc3645527bb785b64d41922cb7a3385ecee0bf39307b7af8f202011b43b6fa019586a6b16e8ccebf696766ef24e1dacce1
+  metadata.gz: 1e520ae74555f68ab1f9d2a247e750c3cc3e428b0ba5ffab14394a5c17f2d72f2289cf5168caa937029ff56bb2f78f85911e83356931e24e314b5aadbfea117e
+  data.tar.gz: ae95c442fa4e84d9cfb5f9303c178b73af325ce497b16efec9ccbeddd28c2e92eda52140e249ae770c2531ba3426016329c6847d2adc929400e0d10c19548f31

data/README.md

@@ -42,8 +42,44 @@ 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/jim.cheung-1512422874962937463.svg'
+Rpictogrify.generate 'jim.cheung', theme: :avataars_male   #=> 'public/system/rpictogrify/1/avataars_male/jim.cheung-2935966159678137421.svg'
+```
+
+### Controllers / Views
+
+There is a helper for this, you need to include `Rpictogrify::Helper` in your controller or helper. e.g. `ApplicationHelper`
+
+```ruby
+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" />'
+```
+
+### Model
+
+You can include `Rpictogrify::Extension` in your model class. e.g. `User` model
+
+```ruby
+class User
+  include Rpictogrify::Extension
+
+  rpictogrify_on :username, theme: -> { gender == :male ? :avataars_male : :avataars_female }
+  # rpictogrify_on :username, theme: :avataars_male
+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'
 ```
 
 ## Contributing

data/lib/rpictogrify.rb

@@ -8,6 +8,8 @@ require 'base64'
 require 'rpictogrify/configuration'
 require 'rpictogrify/generator'
 require 'rpictogrify/inflector'
+require 'rpictogrify/helper'
+require 'rpictogrify/extension'
 
 module Rpictogrify
   class << self
@@ -36,5 +38,9 @@ module Rpictogrify
     def themes_assets_path
       @themes_assets_path ||= assets_path.join('themes')
     end
+
+    def path_to_url(path)
+      path.to_s.sub('public/', '/')
+    end
   end
 end

data/lib/rpictogrify/extension.rb

@@ -0,0 +1,49 @@
+module Rpictogrify
+  module Extension
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def rpictogrify_on(textable, options = {})
+        rpictogrify_settings[:textable] = textable
+        rpictogrify_settings[:options]  = options
+      end
+
+      def rpictogrify_settings
+        @rpictogrify_settings ||= {}
+      end
+    end
+
+    module InstanceMethods
+      def rpictogrify_path(text = nil, options = {})
+        Rpictogrify.generate(text || rpictogrify_text, rpictogrify_options.merge(options || {}))
+      end
+
+      def rpictogrify_url(text = nil, options = {})
+        Rpictogrify.path_to_url(rpictogrify_path(text, options))
+      end
+
+      private
+
+      def rpictogrify_text
+        textable = self.class.rpictogrify_settings[:textable]
+        return unless textable && respond_to?(textable)
+        self.send(textable)
+      end
+
+      def rpictogrify_options
+        options = self.class.rpictogrify_settings[:options] || {}
+        if options[:theme]
+          if options[:theme].respond_to?(:call)
+            options[:theme] = self.instance_exec(&options[:theme])
+          elsif respond_to?(options[:theme])
+            options[:theme] = self.send(options[:theme])
+          end
+        end
+        options
+      end
+    end
+  end
+end

data/lib/rpictogrify/helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Rpictogrify
+  module Helper
+    def rpictogrify_for(text, options = {})
+      Rpictogrify.generate(text, options)
+    end
+
+    def rpictogrify_url(text, options = {})
+      Rpictogrify.path_to_url(rpictogrify_for(text, options))
+    end
+
+    def rpictogrify_tag(text, options = {})
+      html_opts = {alt: text}.merge(options.delete(:html) || {})
+      if defined?(ActionView::Helpers::AssetTagHelper)
+        extend ActionView::Helpers::AssetTagHelper
+        image_tag(rpictogrify_url(text, options), html_opts)
+      else
+        tag = "<img class='#{html_opts[:class]}' src='#{rpictogrify_url(text, options)}' alt='#{html_opts[:alt]}' width='#{html_opts[:width]}' height='#{html_opts[:height]}' />"
+        tag.respond_to?(:html_safe) ? tag.html_safe : tag
+      end
+    end
+  end
+end

data/lib/rpictogrify/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpictogrify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jim Cheung
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-10 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -57,7 +57,9 @@ files:
 - assets/themes/monsters/resource.svg
 - lib/rpictogrify.rb
 - lib/rpictogrify/configuration.rb
+- lib/rpictogrify/extension.rb
 - lib/rpictogrify/generator.rb
+- lib/rpictogrify/helper.rb
 - lib/rpictogrify/inflector.rb
 - lib/rpictogrify/pictogram.rb
 - lib/rpictogrify/theme.rb