cambelt 0.0.1 → 0.1.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.redcar/*

data/README.md

@@ -0,0 +1,62 @@
+Cambelt - Image Placeholders
+============================
+
+<img src="https://cambelt.herokuapp.com/852x120/Cambelt+Placeholders?color=234653,eeeeee&font=Questrial&font_size=30" />
+
+Cambelt is a service that allows you to generate free image placeholders, simply and easily. If you would like to learn more about the service itself, have a look at http://cambelt.co for more information.
+
+
+## Quickstart
+
+To install Cambelt on your machine you can type:
+
+    gem install cambelt
+    
+or use
+
+    gem 'cambelt'
+    
+in your Gemfile.
+
+Cambelt detects if you are running Ruby on Rails, and if so adds a _placeholder_image_tag()_ method to ActionView, allowing you to do:
+
+    <%= placeholder_image_tag %>
+
+in your views and get a nice placeholder back! For your convenience this is also aliased to a simple call of:
+
+    <%= placeholder %>
+    
+## Configuring Cambelt
+
+This gem currently only interfaces with the basic free Cambelt service, which gives a limited number of configuration options that you can set as defaults. When you make a call to _placeholder_image_tag()_, Cambelt checks for these defaults to create the image, but allows you to pass in a hash of values to override any of them.
+
+To configure Cambelt in Rails, you can run the following generator to create a Cambelt initializer file:
+
+    $ rails g cambelt:install
+    
+Then you can edit this file to customise your default settings. If you are not using Rails, then the command to configure Cambelt is the same as in the initializer, and is presented below:
+
+    Cambelt.configure do |config|
+        width = 640
+        height = 360
+        font = "Questrial"
+        font_size = 48
+        text = "Sample Text"
+        bg_color = "#cccccc"
+        fg_color = "#333333"
+    end
+    
+These are the default settings that are provided, so if you are happy with those you don't actually need to call _Cambelt.configure()_ at all. Each of these methods is overridable on any given call to _placeholder_image_tag()_, and to do this you supply a hash as the first parameter:
+
+    placeholder_image_tag(:text => "I love Cambelt!")
+    
+Finally, you can supply a second hash to the method which contains html attributes that your want your image tag to have, so:
+
+    placeholder_image_tag({:text => "I love Cambelt!"}, {:class => "cambelt_is_classy"})
+    
+will give you the following:
+
+    <img src="http://cambelt.co/640x360/I+love+Cambelt!?font=Questrial&font_size=48&color=cccccc,333333" class="cambelt_is_classy" />
+    
+Simple, isn't it?
+      

data/cambelt.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  # s.add_dependency "actionpack"
 end

data/lib/cambelt/configuration.rb

@@ -0,0 +1,19 @@
+module Cambelt
+  class Configuration
+    attr_accessor :width, :height, :font, :font_size, :text
+
+    def initialize
+      @width = 640
+      @height = 360
+      @font = "Questrial"
+      @font_size = 48
+      @text = "Sample Text"
+      @bg_color = "#cccccc"
+      @fg_color = "#333333"
+    end
+    
+    def to_hash
+      self.instance_variables.inject({}) { |hash,var| hash[var[1..-1].to_sym] = self.instance_variable_get(var); hash }
+    end
+  end
+end

data/lib/cambelt/helpers/placeholder.rb

@@ -0,0 +1,23 @@
+module Cambelt
+  module Helpers
+    module Placeholder
+        def placeholder_image_tag(cambelt_opts={}, image_opts={})
+          string = Cambelt.placeholder(cambelt_opts)
+          if defined? Rails
+            image_tag(string, image_opts).html_safe
+          else
+            image_tag(string, image_opts)
+          end
+        end
+        alias_method :placeholder, :placeholder_image_tag
+        
+        private
+        def image_tag(link, options)
+          string = "<img src=\"#{link}\" "
+          options.each{ |key, val| string << "#{key}=\"#{val}\" " }
+          string << ' />'
+          string
+        end
+    end
+  end
+end

data/lib/cambelt/helpers.rb

@@ -0,0 +1,5 @@
+module Cambelt
+  module Helpers
+  end
+end
+require 'cambelt/helpers/placeholder'

data/lib/cambelt/version.rb

@@ -1,3 +1,3 @@
 module Cambelt
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/cambelt.rb

@@ -1,5 +1,31 @@
 require "cambelt/version"
+require "cambelt/configuration"
+require "cambelt/helpers"
 
 module Cambelt
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+    
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+    
+    def placeholder(opts={})
+      args = opts_to_args(opts)
+      "//cambelt.co/#{args[:width]}x#{args[:height]}/#{args[:text].gsub(" ", "+")}?font=#{args[:font]}&font_size=#{args[:font_size]}"
+    end
+    
+    
+    private
+    def opts_to_args(opts)
+      self.configuration ||= Configuration.new
+      self.configuration.to_hash.merge(opts)
+    end
+    
+  end
+end
+
+if defined? Rails
+  require 'rails-helper'
 end

data/lib/rails/generators/cambelt/install/install_generator.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Cambelt
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      
+      desc 'Creates a Cambelt gem initializer at config/initializers/cambelt.rb'
+
+      def self.source_root
+        @_cambelt_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_initializer_file
+        template 'initializer.rb', File.join('config', 'initializers', 'cambelt.rb')
+      end
+
+    end
+  end
+end

data/lib/rails/generators/cambelt/install/templates/initializer.rb

@@ -0,0 +1,16 @@
+#
+# The initializer file for Cambelt - the Image Placeholder service.
+# Currently, all of the settings below are the defaults, to change
+# a default, then please uncomment the top and bottom lines, and then
+# uncomment and change any of the other lines you wish.
+#
+
+#Cambelt.configure do |config|  
+#   width = 640
+#   height = 360
+#   font = "Questrial"
+#   font_size = 48
+#   text = "Sample Text"
+#   bg_color = "#cccccc"
+#   fg_color = "#333333"
+#end

data/lib/rails-helper.rb

@@ -0,0 +1,9 @@
+require 'action_view/helpers'
+ActionView::Helpers::AssetTagHelper.module_eval do
+  include Cambelt::Helpers::Placeholder
+  #def placeholder_image_tag(cambelt_opts={}, image_opts={})
+  #  string = Cambelt.placeholder(cambelt_opts)
+  #  image_tag(string, image_opts)
+  #end
+  #alias_method :placeholder, :placeholder_image_tag
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cambelt
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -21,10 +21,17 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - cambelt.gemspec
 - lib/cambelt.rb
+- lib/cambelt/configuration.rb
+- lib/cambelt/helpers.rb
+- lib/cambelt/helpers/placeholder.rb
 - lib/cambelt/version.rb
+- lib/rails-helper.rb
+- lib/rails/generators/cambelt/install/install_generator.rb
+- lib/rails/generators/cambelt/install/templates/initializer.rb
 homepage: http://cambelt.co
 licenses: []
 post_install_message: