RubyGems - google-webfonts-rails - Versions diffs - 0.0.1 → 0.0.2 - Mend

google-webfonts-rails 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

data/.rspec +2 -0
data/README.md +69 -3
data/google-webfonts-rails.gemspec +7 -4
data/lib/google-webfonts-rails.rb +1 -1
data/lib/google-webfonts/config_renderer.rb +116 -0
data/lib/google-webfonts/rails/helpers.rb +17 -19
data/lib/google-webfonts/version.rb +1 -1
data/spec/google-webfonts/config_renderer_spec.rb +144 -0
data/spec/google-webfonts/rails/helpers_spec.rb +124 -0
data/spec/spec_helper.rb +9 -0
metadata +39 -9

data/.rspec ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --color
2	+ --format documentation

data/README.md CHANGED Viewed

@@ -1,6 +1,12 @@
-# GoogleWebfonts
+# GoogleWebfonts for Rails
-TODO: Write a gem description
+A easiest way to introduce Google WebFonts to Rails application.
+[![Gem Version](https://badge.fury.io/rb/google-webfonts-rails.png)](http://badge.fury.io/rb/google-webfonts-rails)
+We provide an easy to use Google WebFonts Loader. See below about WebFonts Loader.
+<https://developers.google.com/webfonts/docs/webfont_loader>
 ## Installation
@@ -18,7 +24,67 @@ Or install it yourself as:
 ## Usage
-TODO: Write usage instructions here
+### Syntax
+Add following code to your layout file in the `<head>` tag
+    google_webfonts_init(config hash)
+### Configuration
+Google WebFonts:
+    {
+      google: ['Nunito', 'Oxygen']
+    }
+Adobe Typekit:
+    {
+      typekit: 'adobe'
+    }
+Ascender:
+    {
+      ascender: {
+        testKey: ['AscenderSan:bold', 'Calibri']
+      }
+    }
+fonts.com:
+    {
+      monotype: 'test'
+    }
+Fontdeck:
+    {
+      fontdeck: "xxxxx"
+    }
+Custom:
+    {
+      custom: {
+        'OneFontFamily', 'http://example.com/stylesheet1.css',
+        'AnotherFontFamily', 'http://example.com/stylesheet2.css'
+      }
+    }
+The above configuration can be included at the same time.
+Example:
+    {
+      google: ['Nunito', 'Oxygen'],
+      monotype: 'test',
+      custom: {
+        'OneFontFamily', 'http://example.com/stylesheet1.css',
+        'AnotherFontFamily', 'http://example.com/stylesheet2.css'
+      }
+    }
 ## Contributing

data/google-webfonts-rails.gemspec CHANGED Viewed

@@ -8,11 +8,14 @@ Gem::Specification.new do |gem|
   gem.version       = GoogleWebfonts::VERSION
   gem.authors       = ["URAMOTO Kazunori"]
   gem.email         = ["kuprij@mac.com"]
-  gem.description   = %q{Rails 3 helpers to use google webfonts}
-  gem.summary       = %q{Rails 3 helpers to use google webfonts}
-  gem.homepage      = ""
+  gem.description   = %q{A easiest way to introduce Google WebFonts to Rails application.}
+  gem.summary       = %q{A easiest way to introduce Google WebFonts to Rails application.}
+  gem.homepage      = "https://github.com/misopeso/google-webfonts-rails"
-  gem.add_development_dependency 'rspec', '~> 2.8.0'
+  gem.add_runtime_dependency 'activesupport', '~> 3.2.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.12.0'
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/google-webfonts-rails.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module GoogleWebfonts
+  require 'google-webfonts/config_renderer'
 end
 if defined?(Rails)

data/lib/google-webfonts/config_renderer.rb ADDED Viewed

@@ -0,0 +1,116 @@
+module GoogleWebfonts
+  class ConfigRenderer
+    def initialize
+      @config = {}
+    end
+    def google= families
+      return if families.nil?
+      families = [families] unless families.is_a?(Array)
+      return if families.empty?
+      @config.merge!({
+        google: {
+          families: families
+        }
+      })
+    end
+    def typekit= id
+      return if id.nil?
+      @config.merge!({
+        typekit: {
+          id: id
+        }
+      })
+    end
+    def ascender= options
+      return if options.nil?
+      raise ArgumentError, "expected a Hash, got a #{options.class}" unless options.class == Hash
+      return if options.empty?
+      families = options.values.first
+      families = [families] unless families.is_a?(Array)
+      @config.merge!({
+        ascender: {
+          key: options.keys.first.to_s,
+          families: families
+        }
+      })
+    end
+    def monotype= id
+      return if id.nil?
+      @config.merge!({
+        monotype: {
+          projectId: id
+        }
+      })
+    end
+    def fontdeck= id
+      return if id.nil?
+      @config.merge!({
+        fontdeck: {
+          id: id
+        }
+      })
+    end
+    def custom= options
+      return if options.nil?
+      raise ArgumentError, "expected a Hash, got a #{options.class}" unless options.class == Hash
+      return if options.empty?
+      families, urls = [], []
+      options.each do |k, v|
+        families << k.to_s
+        urls << v
+      end
+      @config.merge!({
+        custom: {
+          families: families,
+          urls: urls,
+        }
+      })
+    end
+    def render
+      return "" if @config.empty?
+      <<-JAVASCRIPT
+  WebFontConfig = {
+#{hash_to_js(@config, 2)}
+  };
+      JAVASCRIPT
+    end
+    private
+    def hash_to_js(h, level)
+      buffer = ""
+      h.each do |k, v|
+        buffer << ",\n" unless buffer.empty?
+        buffer << "  " * level + "#{k}: "
+        buffer << "'#{v}'" if v.is_a?(String)
+        buffer << "[#{array_to_js(v)}]" if v.is_a?(Array)
+        buffer << "{\n#{hash_to_js(v, level + 1)}\n" + "  " * level + "}" if v.is_a?(Hash)
+      end
+      buffer
+    end
+    def array_to_js(a)
+      a.map { |e| "'#{e}'" }.join(",")
+    end
+  end
+end

data/lib/google-webfonts/rails/helpers.rb CHANGED Viewed

@@ -10,28 +10,34 @@ module GoogleWebfonts
       # Initialize WebFont Loader javascript. Put it in the head elements.
       #
       # @param config [Hash]
-      #
+      #
       #
       def google_webfonts_init(config = {})
-        google_families = config.delete(:google)
-        google_families = [google_families] unless google_families.is_a?(Array)
+        renderer = GoogleWebfonts::ConfigRenderer.new
+        renderer.google= config.delete(:google)
+        renderer.typekit= config.delete(:typekit)
+        renderer.ascender= config.delete(:ascender)
+        renderer.monotype= config.delete(:monotype)
+        renderer.fontdeck= config.delete(:fontdeck)
+        renderer.custom= config.delete(:custom)
-        print(google_families).html_safe
+        specific_version = config.delete(:version) || "1"
+        construct(renderer, specific_version).html_safe
       end
       private
-      def print(google)
+      def construct(renderer, version)
         <<-JAVASCRIPT
 <script type="text/javascript">
-  WebFontConfig = {
-    #{print_google(google)}
-  };
+#{renderer.render}
   (function() {
     var wf = document.createElement('script');
     wf.src = ('https:' == document.location.protocol ? 'https' : 'http') +
-      '://ajax.googleapis.com/ajax/libs/webfont/1/webfont.js';
+      '#{loader_url(version)}';
     wf.type = 'text/javascript';
     wf.async = 'true';
     var s = document.getElementsByTagName('script')[0];
@@ -41,16 +47,8 @@ module GoogleWebfonts
         JAVASCRIPT
       end
-      def print_google(config)
-        return "" if config.nil?
-        families = config.map { |c| "'#{c}'" }.join(",")
-        <<-JAVASCRIPT
-    google: {
-      families: [#{families}]
-    },
-        JAVASCRIPT
+      def loader_url(version)
+        "://ajax.googleapis.com/ajax/libs/webfont/#{version}/webfont.js"
       end
     end
   end

data/lib/google-webfonts/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module GoogleWebfonts
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/google-webfonts/config_renderer_spec.rb ADDED Viewed

@@ -0,0 +1,144 @@
+require 'spec_helper'
+describe GoogleWebfonts::ConfigRenderer do
+  before do
+    @render = GoogleWebfonts::ConfigRenderer.new
+  end
+  context "with google webfonts settings" do
+    it "should process a argument" do
+      @render.google = 'Nunito'
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:google)
+      h[:google].should have_key(:families)
+      h[:google][:families].should be_is_a(Array)
+      h[:google][:families].should include('Nunito')
+      h[:google][:families].should have(1).items
+    end
+    it "should process an array arguments" do
+      @render.google = ['Nunito', 'Oxygen']
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:google)
+      h[:google].should have_key(:families)
+      h[:google][:families].should be_is_a(Array)
+      h[:google][:families].should include('Nunito')
+      h[:google][:families].should include('Oxygen')
+      h[:google][:families].should have(2).items
+    end
+    it "should ignore nil without error" do
+      @render.google = nil
+      h = @render.instance_variable_get(:@config)
+      h.should be_empty
+    end
+    it "should ignore empty array without error" do
+      @render.google = []
+      h = @render.instance_variable_get(:@config)
+      h.should be_empty
+    end
+  end
+  context "with adobe typekit settings" do
+    it "should process id string" do
+      @render.typekit = 'a12345'
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:typekit)
+      h[:typekit].should have_key(:id)
+      h[:typekit][:id].should == 'a12345'
+    end
+  end
+  context "with ascender settings" do
+    it "should process key and one family" do
+      @render.ascender = {testAscenderKey: 'AscenderSan:bold'}
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:ascender)
+      h[:ascender].should have_key(:key)
+      h[:ascender][:key].should == 'testAscenderKey'
+      h[:ascender].should have_key(:families)
+      h[:ascender][:families].should be_is_a(Array)
+      h[:ascender][:families].should include('AscenderSan:bold')
+      h[:ascender][:families].should have(1).items
+    end
+    it "should process key and multi families" do
+      @render.ascender = {testAscenderKey: ['AscenderSan:bold', 'Calibri']}
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:ascender)
+      h[:ascender].should have_key(:key)
+      h[:ascender][:key].should == 'testAscenderKey'
+      h[:ascender].should have_key(:families)
+      h[:ascender][:families].should be_is_a(Array)
+      h[:ascender][:families].should include('AscenderSan:bold')
+      h[:ascender][:families].should include('Calibri')
+      h[:ascender][:families].should have(2).items
+    end
+  end
+  context "with monotype(fonts.com) settings" do
+    it "should process project id" do
+      @render.monotype = 'testProjectId'
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:monotype)
+      h[:monotype].should have_key(:projectId)
+      h[:monotype][:projectId].should == 'testProjectId'
+    end
+  end
+  context "with fontdeck settings" do
+    it "should process id string" do
+      @render.fontdeck = 'xxxxx'
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:fontdeck)
+      h[:fontdeck].should have_key(:id)
+      h[:fontdeck][:id].should == 'xxxxx'
+    end
+  end
+  context "with custom settings" do
+    it "should process one entry" do
+      @render.custom = {'OneFont' => 'http://example.com/stylesheet1.css'}
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:custom)
+      h[:custom].should have_key(:families)
+      h[:custom][:families].should be_is_a(Array)
+      h[:custom][:families].should have(1).items
+      h[:custom][:families].should include('OneFont')
+      h[:custom].should have_key(:urls)
+      h[:custom][:urls].should be_is_a(Array)
+      h[:custom][:urls].should include('http://example.com/stylesheet1.css')
+    end
+    it "should process multi entries" do
+      @render.custom = {
+        'OneFont' => 'http://example.com/stylesheet1.css',
+        'AnotherFont' => 'http://example.com/stylesheet2.css'
+      }
+      h = @render.instance_variable_get(:@config)
+      h.should have_key(:custom)
+      h[:custom].should have_key(:families)
+      h[:custom][:families].should be_is_a(Array)
+      h[:custom][:families].should include('OneFont')
+      h[:custom][:families].should include('AnotherFont')
+      h[:custom][:families].should have(2).items
+      h[:custom].should have_key(:urls)
+      h[:custom][:urls].should be_is_a(Array)
+      h[:custom][:urls].should include('http://example.com/stylesheet1.css')
+      h[:custom][:urls].should include('http://example.com/stylesheet2.css')
+      h[:custom][:urls].should have(2).items
+    end
+  end
+end

data/spec/google-webfonts/rails/helpers_spec.rb ADDED Viewed

@@ -0,0 +1,124 @@
+require 'spec_helper'
+describe GoogleWebfonts::Rails::Helpers do
+  def self.helper_method(*methods)
+    # Pseudo method
+  end
+  include GoogleWebfonts::Rails::Helpers
+  describe "#google_webfonts_init" do
+    context "with no arguments" do
+      it "should output script without WebFontConfig" do
+        google_webfonts_init.should_not =~ /WebFontConfig/
+      end
+    end
+    context "with google webfonts" do
+      it "should output with Google WebFonts entry" do
+        google_webfonts_init({
+          google: ['Nunito', 'Oxygen']
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    google: {
+      families: ['Nunito','Oxygen']
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+    context "with adobe typekit" do
+      it "should output with Adobe Typekit entry" do
+        google_webfonts_init({
+          typekit: 'adobe'
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    typekit: {
+      id: 'adobe'
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+    context "with ascender" do
+      it "should output with Ascender entry" do
+        google_webfonts_init({
+          ascender: {testkey: ["AscenderSan:bold", "Calibri"]}
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    ascender: {
+      key: 'testkey',
+      families: ['AscenderSan:bold','Calibri']
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+    context "with monotype(fonts.com)" do
+      it "should output with Monotype entry" do
+        google_webfonts_init({
+          monotype: "test"
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    monotype: {
+      projectId: 'test'
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+    context "with fontdeck" do
+      it "should output with Fontdeck entry" do
+        google_webfonts_init({
+          fontdeck: "xxxxx"
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    fontdeck: {
+      id: 'xxxxx'
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+    context "with custom" do
+      it "should output with pseudo font provider" do
+        google_webfonts_init({
+          custom: {
+            'OneFont' => 'http://example.com/stylesheet1.css',
+            'AnotherFont' => 'http://example.com/stylesheet2.css'
+          }
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    custom: {
+      families: ['OneFont','AnotherFont'],
+      urls: ['http://example.com/stylesheet1.css','http://example.com/stylesheet2.css']
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+    context "with multiple font provider" do
+      it "should output with Google Webfonts and Monotype entries" do
+        google_webfonts_init({
+          google: ['Nunito', 'Oxygen'],
+          monotype: "test"
+        }).should include <<-JAVASCRIPT
+  WebFontConfig = {
+    google: {
+      families: ['Nunito','Oxygen']
+    },
+    monotype: {
+      projectId: 'test'
+    }
+  };
+        JAVASCRIPT
+      end
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'json'
+require 'google-webfonts-rails'
+require 'active_support/core_ext'
+require 'google-webfonts/rails/helpers'
+RSpec.configure do
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-webfonts-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease:
 platform: ruby
 authors:
@@ -9,20 +9,42 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-01-20 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70104508456600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70104508456600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70104508456180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70104508456180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70195298503580 !ruby/object:Gem::Requirement
+  requirement: &70104508455640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70195298503580
-description: Rails 3 helpers to use google webfonts
+  version_requirements: *70104508455640
+description: A easiest way to introduce Google WebFonts to Rails application.
 email:
 - kuprij@mac.com
 executables: []
@@ -30,15 +52,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - google-webfonts-rails.gemspec
 - lib/google-webfonts-rails.rb
+- lib/google-webfonts/config_renderer.rb
 - lib/google-webfonts/rails/helpers.rb
 - lib/google-webfonts/version.rb
-homepage: ''
+- spec/google-webfonts/config_renderer_spec.rb
+- spec/google-webfonts/rails/helpers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/misopeso/google-webfonts-rails
 licenses: []
 post_install_message:
 rdoc_options: []
@@ -61,5 +88,8 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key:
 specification_version: 3
-summary: Rails 3 helpers to use google webfonts
-test_files: []
+summary: A easiest way to introduce Google WebFonts to Rails application.
+test_files:
+- spec/google-webfonts/config_renderer_spec.rb
+- spec/google-webfonts/rails/helpers_spec.rb
+- spec/spec_helper.rb