vanillicons 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.1.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Gary Mardell
+
+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

@@ -0,0 +1,71 @@
+# vanillicons
+
+A quick and simple way of using [vanillicons](http://vanillicon.com) in your next project. 
+
+## Install
+    gem install 'vanillicons'
+
+## Usage
+If you are using this in a Rails project, or a project using Bundler then add the following to your `Gemfile`  
+
+    gem 'vanillicons', '0.1.0'
+
+In your model or class include the Vanillicons module
+
+    class User < ActiveRecord::Base
+      include Vanillicons 
+    end
+
+And thats all it takes to get started, in your views you can now use the `#vanillicon_url` method.
+
+    <%= image_tag @user.vanillicon_url %>
+
+
+### Changing the field used
+By default the gem will call a method `#email` on the object and hash that value. However you can change this to use any other field in the class, to change it you can do the following.
+
+    class User < ActiveRecord::Base
+      include Vanillicons 
+    
+      vanillicon :name
+    end
+
+The gem will now call the `#name` accessor to generate the image url.
+
+### Changing the options
+
+There are a couple of options that can be passed to the `#vanillicon_url` method. The defaults are the following.  
+
+    {
+      :size => 200, # Options are: 50, 100, 200
+      :secure => true
+    }
+
+This sets the image size to 200px by 200px and to use https connection.  
+You may override this when calling the `#vanillicon_url` method.  
+
+    <%= image_tag @user.vanillicon_url(:size => 50, :secure => false) %>
+
+Or in the class if you frequently use a particular set of options. 
+
+    class User < ActiveRecord::Base
+      include Vanillicons 
+    
+      vanillicon :email, :size => 100
+    end
+
+
+## Contributing to vanillicons
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Gary Mardell. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "vanillicons"
+  gem.homepage = "http://github.com/garymardell/vanillicons"
+  gem.license = "MIT"
+  gem.summary = %Q{Generates the address for a vanillicon image}
+  gem.description = %Q{Vanillicons are a small generated avatar made by vanillaforums.org, they use a md5 hash as the image key. Images can be generated on the site at vanillicon.com. The images come in 3 different sizes; 50px, 100px and 200px.}
+  gem.email = "info@garymardell.co.uk"
+  gem.authors = ["Gary Mardell"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vanillicons #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/vanillicons.rb

@@ -0,0 +1,91 @@
+require 'digest/md5'
+
+module Vanillicons
+  
+  def self.included(base)    
+    base.send :include, InstanceMethods
+    base.send :extend, ClassMethods    
+  end
+  
+  module ClassMethods
+      
+    attr_reader :vanillicon_field
+    
+    def vanillicon(field, options = {})
+      options = options.is_a?(Hash) ? options : {}
+      
+      # Set the field to generate the url based on
+      @vanillicon_field = field
+      
+      # Merge the options into the default options
+      @vanillicon_options = self.vanillicon_defaults.merge(options)      
+    end
+  
+    def vanillicon_defaults
+      {
+        :secure => true,
+        :size => 200
+      }
+    end
+    
+    def vanillicon_options
+      @vanillicon_options || self.vanillicon_defaults
+    end
+  end
+  
+  module InstanceMethods
+    
+    def vanillicon_url(options = {})
+      options = options.is_a?(Hash) ? options : {}
+      options = self.class.vanillicon_options.merge(options)
+      
+      vanillicon_host(options[:secure]) + vanillicon_id(options[:size]) + vanillicon_image_extension
+    end
+    
+    def vanillicon_hash
+      # Generate hash based on field set
+      Digest::MD5.hexdigest(send(vanillicon_field).to_s)
+    end
+    
+    def vanillicon_id(size)
+      "#{vanillicon_hash}_#{exact_or_larger_size(size)}"
+    end
+    
+    private
+    
+    def available_sizes
+      [50, 100, 200]
+    end
+    
+    def exact_or_larger_size(size)
+      # If size is set use that
+      if available_sizes.include? size
+        size
+      else
+        sizes = available_sizes.sort
+        
+        # Get the largest size if the size given is greater than the largest value
+        if size > sizes.last
+          sizes.last
+        else
+          # Get the size next up from the size given
+          sizes.reject { |s| s < size }.first
+        end      
+      end
+    end
+    
+    def vanillicon_host(secure = true)
+      (secure ? 'https' : 'http') + '://vanillicon.com/' 
+    end
+    
+    def vanillicon_field
+      self.class.vanillicon_field || :email
+    end
+    
+    def vanillicon_image_extension
+      '.png'
+    end
+    
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'vanillicons'
+
+class Test::Unit::TestCase
+end

data/test/test_vanillicons.rb

@@ -0,0 +1,76 @@
+require 'helper'
+
+class TestVanillicons < Test::Unit::TestCase
+  
+  def setup
+    # Create a new class with an email method
+    @klass = Class.new do |c|
+      c.send(:include, Vanillicons)
+      c.send(:attr_accessor, :email)
+    end
+    
+    # Create a new instance with example email
+    @instance = @klass.new
+    @instance.email = 'example@example.com'
+  end
+  
+  should "have the method vanillicon" do
+    assert @klass.respond_to? :vanillicon
+  end
+  
+  should "have the method vanillicon_url" do
+    assert @klass.method_defined? :vanillicon_url
+  end
+  
+  should "give the secure host" do
+    assert_equal "https://vanillicon.com/", @instance.send(:vanillicon_host, true)
+  end
+  
+  should "give the non-secure host" do
+    assert_equal "http://vanillicon.com/", @instance.send(:vanillicon_host, false)
+  end
+  
+  should "default to secure host" do
+    assert_equal "https://vanillicon.com/", @instance.send(:vanillicon_host)
+  end
+  
+  should "give the available sizes" do
+    assert_equal [50, 100, 200], @instance.send(:available_sizes)
+  end
+  
+  should "give size or larger size" do
+    assert_equal 50, @instance.send(:exact_or_larger_size, 20)
+    assert_equal 50, @instance.send(:exact_or_larger_size, 50)
+    
+    assert_equal 100, @instance.send(:exact_or_larger_size, 60)
+    assert_equal 100, @instance.send(:exact_or_larger_size, 99)
+    assert_equal 100, @instance.send(:exact_or_larger_size, 100)
+    
+    assert_equal 200, @instance.send(:exact_or_larger_size, 110)
+    assert_equal 200, @instance.send(:exact_or_larger_size, 199)
+    assert_equal 200, @instance.send(:exact_or_larger_size, 200)
+    assert_equal 200, @instance.send(:exact_or_larger_size, 500)    
+  end
+  
+  should "default field to email" do
+    assert_equal :email, @instance.send(:vanillicon_field)
+  end
+  
+  should "have field of name" do  
+    @instance.class.vanillicon :name
+    assert_equal :name, @instance.send(:vanillicon_field)
+  end
+  
+  should "md5 hash field" do
+    assert_equal "23463b99b62a72f26ed677cc556c44e8", @instance.vanillicon_hash
+  end
+  
+  should "generate vanillicon url for { :size => 50, :secure => false }" do
+    assert_equal "http://vanillicon.com/23463b99b62a72f26ed677cc556c44e8_50.png", @instance.vanillicon_url(:size => 50, :secure => false)
+  end
+  
+  should "generate vanillicon for size 200 url for { :size => 300 }" do
+    assert_equal "https://vanillicon.com/23463b99b62a72f26ed677cc556c44e8_200.png", @instance.vanillicon_url(:size => 300)
+  end
+  
+end

data/vanillicons.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "vanillicons"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gary Mardell"]
+  s.date = "2012-07-10"
+  s.description = "Vanillicons are a small generated avatar made by vanillaforums.org, they use a md5 hash as the image key. Images can be generated on the site at vanillicon.com. The images come in 3 different sizes; 50px, 100px and 200px."
+  s.email = "info@garymardell.co.uk"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/vanillicons.rb",
+    "test/helper.rb",
+    "test/test_vanillicons.rb",
+    "vanillicons.gemspec"
+  ]
+  s.homepage = "http://github.com/garymardell/vanillicons"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Generates the address for a vanillicon image"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: vanillicons
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gary Mardell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70255809043240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255809043240
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70255809042580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70255809042580
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70255809041800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70255809041800
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70255809040840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *70255809040840
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70255809039160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255809039160
+description: Vanillicons are a small generated avatar made by vanillaforums.org, they
+  use a md5 hash as the image key. Images can be generated on the site at vanillicon.com.
+  The images come in 3 different sizes; 50px, 100px and 200px.
+email: info@garymardell.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/vanillicons.rb
+- test/helper.rb
+- test/test_vanillicons.rb
+- vanillicons.gemspec
+homepage: http://github.com/garymardell/vanillicons
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1297365350994984390
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Generates the address for a vanillicon image
+test_files: []