RubyGems - GoogleWebfonts - Versions diffs - 0.3.0 - Mend

GoogleWebfonts 0.3.0

Files changed (18) hide show

checksums.yaml +7 -0
data/.gitignore +18 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/README.md +95 -0
data/Rakefile +9 -0
data/google-webfonts.gemspec +30 -0
data/lib/google-webfonts.rb +22 -0
data/lib/google-webfonts/helper.rb +44 -0
data/lib/google-webfonts/link_tag.rb +78 -0
data/lib/google-webfonts/sinatra.rb +3 -0
data/lib/google-webfonts/version.rb +6 -0
data/test/lib/google-webfonts/helper_test.rb +21 -0
data/test/lib/google-webfonts/link_tag_test.rb +52 -0
data/test/lib/google-webfonts/sinatra_test.rb +25 -0
data/test/lib/google-webfonts_test.rb +11 -0
data/test/test_helper.rb +16 -0
metadata +143 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d0ad2495f84477a076a21ea776ee490181de4e6
+  data.tar.gz: 4f92b21c09fb4cfdda54a87558476bcb155234df
+SHA512:
+  metadata.gz: dc76a8c7d42ed429dbc987d0149551f9c719ae20f2d5dc5511b473aecdc50fcdcfd5644907d4912c9b6753ce7115fe4cfe531adaabddcad4538e4bb3be9a7e06
+  data.tar.gz: '02719ce2aa40ebfc36f9559910829bc4a92bd3e324548654fc7faea75034adb385b431150db950c88de2c36416875d0b5fa0f2b91bbef4346d91cfdfc267b796'

data/.gitignore ADDED

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in google-webfonts.gemspec
+gemspec

data/LICENSE ADDED

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Travis Haynes
+MIT License
+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 ADDED

@@ -0,0 +1,95 @@
+# Google::Webfonts
+Provides a helper for using [Google Webfonts](http://www.google.com/webfonts) in
+Rails or Sinatra.
+## Installation
+Add this line to your application's Gemfile:
+    gem 'google-webfonts'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install google-webfonts
+## Usage
+### Syntax
+    google_webfonts_link_tag :font_name => [sizes], ...
+### Examples
+Basic usage:
+    google_webfonts_link_tag :droid_sans        => [400, 700],
+                             :yanone_kaffeesatz => [300, 400]
+The sizes are optional, and do not have to be in an Array if you are only
+including one size. For example:
+    google_webfonts_link_tag :droid_sans
+    # => generates a tag for Droid+Sans without specifying the font weight
+    google_webfonts_link_tag :droid_sans => 400
+    # => generates a tag for Droid+Sans with 400 weight
+    google_webfonts_link_tag :droid_sans => [400, 700]
+    # => generates a tag for Droid+Sans with 400 and 700 weights
+You can also use a String instead of a Symbol if you'd prefer. For example:
+    google_webfonts_link_tag "Droid Sans", "Yanone Kaffeesatz" => 400
+    # includes Droid+Sans without a specified weight
+    # and Yanone+Kaffeesatz with weight 400
+### Using in Rails
+No additional work required to use this gem in a Rails application. Just add
+it to your application's Gemfile, and it is automatically available in your
+views.
+You will, however, need to `include Google::Webfonts::Helper` if you want to use
+it outside of a view.
+### Using in Sinatra
+Here is a simple "Hello World" example for using Google::Webfonts in a Sinatra
+app:
+    # app.rb
+    require 'rubygems'
+    require 'sinatra'
+    require 'google-webfonts' # <= this must be required after 'sinatra'
+    get '/' do
+      erb :index
+    end
+###
+    # views/index.erb
+    <html>
+      <head>
+        <%= google_webfonts_link_tag "Droid Sans" %>
+      </head>
+      <body>
+        <p style="font-family: 'Droid+Sans', sans-serif;">
+          Hello World!
+        </p>
+      </body>
+    </html>
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Ensure what your code is well tested, and all the tests pass. (`rspec spec`)
+6. Create new Pull Request

data/Rakefile ADDED

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+task :default => [:test]

data/google-webfonts.gemspec ADDED

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google-webfonts/version'
+Gem::Specification.new do |spec|
+  spec.name = "GoogleWebfonts"
+  spec.version = Google::Webfonts::VERSION
+  spec.authors = ["Travis Haynes", "Evgeniy Kulikov"]
+  spec.email = ["travis.j.haynes@gmail.com", "im@kulikov.im"]
+  spec.summary = "Provides a helper for using Google Webfonts in Rails or " +
+                 "Sinatra, although it can be used outside of those " +
+                 "frameworks as well."
+  spec.description = "Google Webfonts helper for Rails or Sinatra applications."
+  spec.homepage = "https://github.com/im-kulikov/Google-Webfonts-Helper"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'actionpack', '>= 3.0.0'
+  spec.add_development_dependency 'bundler', '>= 1.3.0', '< 2.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.3.3'
+  spec.add_development_dependency 'sinatra', '~> 1.3.2'
+end

data/lib/google-webfonts.rb ADDED

@@ -0,0 +1,22 @@
+require 'uri'
+require 'action_view'
+require 'active_support/core_ext'
+require 'action_dispatch/http/mime_type'
+# Public: Module for Google helpers
+module Google
+  # Public: Module for Google Webfonts helpers
+  module Webfonts
+    HOST = 'fonts.googleapis.com'
+    PATH = '/css'
+  end
+end
+require 'google-webfonts/version'
+require 'google-webfonts/link_tag'
+require 'google-webfonts/helper'
+require 'google-webfonts/sinatra' if defined? Sinatra
+# include the webfonts helper methods in the Rails view helpers
+ActionView::Base.send :include, Google::Webfonts::Helper

data/lib/google-webfonts/helper.rb ADDED

@@ -0,0 +1,44 @@
+module Google
+  module Webfonts
+    # Public: Helper module that includes the google_webfonts_link_tag method.
+    # This module is automatically included in your Rails view helpers.
+    module Helper
+      # Public: Generates a Google Webfonts link tag
+      #
+      # If you need to specify a font size, use a Hash. Symbols will be
+      # titleized, so if the font you're using uses a specialized case
+      # (e.g: "PT Sans"), then you'll need to use a String.
+      #
+      # You can specify subsets by using the :subset option. Note that this must
+      # be a Symbol. "Subset" and "subset" would be turned into a font.
+      #
+      # options - The font options. This can be a String, Symbol, or Hash, or
+      #           a combination of all three.
+      #
+      # Examples
+      #
+      #   google_webfonts_link_tag "PT Sans"
+      #
+      #   google_webfonts_link_tag :droid_sans
+      #
+      #   google_webfonts_link_tag droid_sans: [400, 700]
+      #
+      #   google_webfonts_link_tag droid_sans: [400, 700],
+      #                            yanone_kaffeesatz: 700
+      #
+      #   google_webfonts_link_tag :droid_sans,
+      #                            yanone_kaffeesatz: 400,
+      #                            "PT Sans" => [400, 700]
+      #
+      #   google_webfonts_link_tag :droid_sans, subset: %w[latin cyrillic]
+      #
+      # Returns a <link> tag for the Google Webfonts stylesheet.
+      # Raises ArgumentError if no options are passed.
+      def google_webfonts_link_tag(*opts)
+        raise ArgumentError, 'expected at least one font', caller if opts.empty?
+        LinkTag.new(request, *opts).result
+      end
+    end
+  end
+end

data/lib/google-webfonts/link_tag.rb ADDED

@@ -0,0 +1,78 @@
+module Google
+  module Webfonts
+    class LinkTag
+      include ActionView::Helpers::TagHelper
+      attr_reader :result
+      alias_method :to_s, :result
+      def initialize(request, *opts)
+        @request = request
+        @subsets = []
+        @fonts = fonts_from_options(opts)
+        @result = tag(:link, link_options, false, false)
+      end
+      private
+      def fonts_from_options(opts)
+        opts.map {|option| parse_google_webfont_option(option) }.flatten
+      end
+      def parse_google_webfont_option(option)
+        case option
+        when Symbol, String then parse_google_webfont_name(option)
+        when Hash then parse_google_webfont_hash(option)
+        else ""
+        end
+      end
+      def parse_google_webfont_hash(hash)
+        add_subsets(hash.delete(:subset))
+        hash.inject([]) do |result, (font_name, sizes)|
+          font_name = parse_google_webfont_name(font_name)
+          result << "#{font_name}:#{Array(sizes).join(",")}"
+        end
+      end
+      def parse_google_webfont_name(name)
+        name = name.to_s.titleize if name.is_a?(Symbol)
+        name.gsub("_", " ")
+      end
+      def link_options
+        { rel: 'stylesheet',
+          type: type_css,
+          href: uri.to_s }
+      end
+      def add_subsets(subsets)
+        @subsets += Array(subsets)
+      end
+      def uri
+        u = @request.ssl? ? URI::HTTPS : URI::HTTP
+        u.build(host: HOST, path: PATH, query: uri_query)
+      end
+      def uri_query
+        {}.tap {|q|
+          q['family'] = @fonts.join("|")
+          q['subset'] = @subsets.join(",") if @subsets.any?
+        }.to_query
+      end
+      private
+        def type_css
+          if ActionPack::VERSION::MAJOR < 5
+            return Mime::CSS
+          end
+          return Mime[:css]
+        end
+    end
+  end
+end

data/lib/google-webfonts/sinatra.rb ADDED

@@ -0,0 +1,3 @@
+module Sinatra
+  helpers Google::Webfonts::Helper
+end

data/lib/google-webfonts/version.rb ADDED

@@ -0,0 +1,6 @@
+module Google
+  module Webfonts
+    # Public: Current version of the gem
+    VERSION = "0.3.0"
+  end
+end

data/test/lib/google-webfonts/helper_test.rb ADDED

@@ -0,0 +1,21 @@
+require 'test_helper'
+module Google
+  module Webfonts
+    class HelperTest < Minitest::Test
+      include Helper
+      def test_google_webfonts_link_tag
+        options = { droid_sans: [400, 700] }
+        link_tag = LinkTag.new(request, options)
+        assert_equal link_tag.result, google_webfonts_link_tag(options)
+      end
+      private
+      def request
+        OpenStruct.new(:ssl? => false)
+      end
+    end
+  end
+end

data/test/lib/google-webfonts/link_tag_test.rb ADDED

@@ -0,0 +1,52 @@
+require 'test_helper'
+module Google
+  module Webfonts
+    class LinkTagTest < Minitest::Test
+      def setup
+        @http_request = OpenStruct.new(:ssl? => false)
+        @https_request = OpenStruct.new(:ssl? => true)
+      end
+      def test_subsets
+        tag = LinkTag.new(@http_request, droid_sans: [400, 700],
+          subset: %w[latin cyrillic]).result
+        assert_tag tag, 'link',
+          href: 'http://fonts.googleapis.com/css?family=Droid+Sans%3A400%2C700&subset=latin%2Ccyrillic'
+      end
+      def test_uri_protocol
+        tag = LinkTag.new(@http_request, droid_sans: [400, 700]).result
+        assert_tag tag, 'link',
+          href: 'http://fonts.googleapis.com/css?family=Droid+Sans%3A400%2C700'
+        tag = LinkTag.new(@https_request, droid_sans: [400, 700]).result
+        assert_tag tag, 'link',
+          href: 'https://fonts.googleapis.com/css?family=Droid+Sans%3A400%2C700'
+      end
+      def test_with_font_sizes
+        tag = LinkTag.new(@http_request, droid_sans: [400, 700]).result
+        assert_tag tag, 'link',
+          href: 'http://fonts.googleapis.com/css?family=Droid+Sans%3A400%2C700'
+        tag = LinkTag.new(@http_request, droid_sans: [400, 700],
+          'PT Sans' => [400, 700]).result
+        assert_tag tag, 'link',
+          href: 'http://fonts.googleapis.com/css?family=Droid+Sans%3A400%2C700%7CPT+Sans%3A400%2C700'
+      end
+      def test_strings_are_not_titleized
+        tag = LinkTag.new(@http_request, 'PT Sans').result
+        assert_tag tag, 'link',
+          href: 'http://fonts.googleapis.com/css?family=PT+Sans'
+      end
+      def test_symbols_are_titleized
+        tag = LinkTag.new(@http_request, :droid_sans).result
+        assert_tag tag, 'link',
+          href: 'http://fonts.googleapis.com/css?family=Droid+Sans'
+      end
+    end
+  end
+end

data/test/lib/google-webfonts/sinatra_test.rb ADDED

@@ -0,0 +1,25 @@
+require 'test_helper'
+# create a Sinatra route for testing
+get("/") { google_webfonts_link_tag droid_sans: [400, 700] }
+class SinatraTest < Minitest::Test
+  include Rack::Test::Methods
+  def app
+    Sinatra::Application
+  end
+  def test_google_webfonts_link_tag_helper_loaded_in_sinatra
+    get "/"
+    options = { droid_sans: [400, 700] }
+    link_tag = Google::Webfonts::LinkTag.new(request, options)
+    assert_equal link_tag.result, last_response.body
+  end
+  private
+  def request
+    OpenStruct.new(:ssl? => false)
+  end
+end

data/test/lib/google-webfonts_test.rb ADDED

@@ -0,0 +1,11 @@
+require 'test_helper'
+class Google::WebfontsTest < Minitest::Test
+  def test_helper_is_included_in_action_view_base
+    assert ActionView::Base.ancestors.include?(Google::Webfonts::Helper)
+  end
+  def test_helper_is_included_in_sinatra
+    assert Sinatra::Application.ancestors.include?(Google::Webfonts::Helper)
+  end
+end

data/test/test_helper.rb ADDED

@@ -0,0 +1,16 @@
+ENV['RACK_ENV'] = 'test'
+require 'ostruct'
+require 'sinatra'
+require 'google-webfonts'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'rack/test'
+class Minitest::Test
+  def assert_tag(el, tag, props={})
+    assert el =~ /<#{tag}.*\/>/ , "expected a #{tag} tag"
+    assert props.all? {|key, value| el.include?("#{key}=\"#{value}\"") },
+      "tag's properties do not match"
+  end
+end

metadata ADDED

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: GoogleWebfonts
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Travis Haynes
+- Evgeniy Kulikov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.3.3
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+description: Google Webfonts helper for Rails or Sinatra applications.
+email:
+- travis.j.haynes@gmail.com
+- im@kulikov.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- google-webfonts.gemspec
+- lib/google-webfonts.rb
+- lib/google-webfonts/helper.rb
+- lib/google-webfonts/link_tag.rb
+- lib/google-webfonts/sinatra.rb
+- lib/google-webfonts/version.rb
+- test/lib/google-webfonts/helper_test.rb
+- test/lib/google-webfonts/link_tag_test.rb
+- test/lib/google-webfonts/sinatra_test.rb
+- test/lib/google-webfonts_test.rb
+- test/test_helper.rb
+homepage: https://github.com/im-kulikov/Google-Webfonts-Helper
+licenses: []
+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: []
+rubyforge_project:
+rubygems_version: 2.6.11
+signing_key:
+specification_version: 4
+summary: Provides a helper for using Google Webfonts in Rails or Sinatra, although
+  it can be used outside of those frameworks as well.
+test_files:
+- test/lib/google-webfonts/helper_test.rb
+- test/lib/google-webfonts/link_tag_test.rb
+- test/lib/google-webfonts/sinatra_test.rb
+- test/lib/google-webfonts_test.rb
+- test/test_helper.rb