rails-sprite 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bdf4afdb36326a383ee1eafeb164ca1f15863a4
-  data.tar.gz: 6786b97bb35376d7ee9473b57b42af688fbd0911
+  metadata.gz: f157a0f5de96f72a61f81f0ebfa2335ed77ae7ff
+  data.tar.gz: 14fd846978fc6cbd84d2eb98b2ab01666e339d92
 SHA512:
-  metadata.gz: ff963d2689f1c731b350569a4820619d2d15d8442d9a7ce5953feb21d228ff799bd3314cd700ac2f9d9da2b6efb859bef9b5feed6e894404cc19bda4849495af
-  data.tar.gz: 92bd47684ad7c00278d1c8b042ae3fcaa498aa1b23d32a12414d20e12cba1c7e5d53cc9d181850c0494ec766d506ee4be63abf6f6d286db1c2c91d45ff88ba16
+  metadata.gz: f5169614a58b7d62a735f7762fc063d4b89dbfbd41eabe72c17595ed27071f3e70594152bd2903750b5bcd91c42e29e6faae80ee42b3a69c700cd5b1891b0db9
+  data.tar.gz: 2883501ba85d27388fa782fc91d42c8d4eb4755846baff536f9cc04f10660e7d39ad69ae7ccfa11a8bbfe8decef215fc443b37a7d1e914103c1f74476fcea451

data/README.md

@@ -0,0 +1,34 @@
+# RailsSprite
+
+```
+  eg.
+
+    image source folder:
+
+      app/assets/images/rails_xxx/sprite_sources
+
+    image sprite source:
+
+      icons/16x16/*.png
+      icons/32x32/*.png
+
+    image sprice to:
+
+      app/assets/images/rails_xxx/sprite
+
+    config:
+
+      simple:
+
+      RailsSprite.sprite(
+        :root_path => "#{File.dirpath(__FILE__)}/..",
+        :scope_name => "rails_xxx/",
+        :recipe_path => "icons/16x16",
+        :file_extend => '.png',
+        :spacing => 10,
+        :css_class_shared => 'rails_xxx-icon',
+        :css_class_prefix => 'icons-16x16-'
+      )
+
+    
+```

data/Rakefile

@@ -21,3 +21,14 @@ end
 
 Bundler::GemHelper.install_tasks
 
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails-sprite.rb

@@ -0,0 +1,8 @@
+require 'rails_sprite/sprite_util'
+require 'rails_sprite/library/rmagick'
+
+module RailsSprite
+  def self.sprite options={}
+    ::RailsSprite::SpriteUtil.new( options ).perform
+  end
+end

data/lib/rails_sprite/library/rmagick.rb

@@ -0,0 +1,30 @@
+require 'RMagick'
+
+module RailsSprite
+  module Library
+    module RMagick
+
+      VALID_EXTENSIONS = [:png, :jpg, :jpeg, :gif, :ico]
+
+      def self.load(filename)
+        image = Magick::Image.read(filename)[0]
+
+        {
+          :image    => image,
+          :width    => image.columns,
+          :height   => image.rows
+        }
+      end
+
+      def self.create(filename, images, width, height)
+        target = Magick::Image.new(width, height)
+        target.opacity = Magick::QuantumRange
+        images.each do |image|
+          target.composite!(image[:image], image[:x], image[:y], Magick::SrcOverCompositeOp)
+        end
+        target.write(filename)
+      end
+
+    end # module RMagick
+  end # module Library
+end # module SpriteFactory

data/lib/rails_sprite/sprite_util.rb

@@ -0,0 +1,141 @@
+require "rails_sprite/stylesheet_generator"
+
+module RailsSprite
+  class SpriteUtil
+    attr_reader :root_path, :scope_name, :recipe_path, :file_extend,
+      :spacing, :image_to_folder, :image_source_folder,
+      :stylesheet_to, :image_to_file_path, :css_class_prefix, :css_class_shared,
+      :image_scope_name, :stylesheet_scope_name,
+      :css_extend, :file_extend_name
+
+    #
+    #  :root_path => '.',
+    #  :scope_name => "rails_xxx",
+    #  :recipe_path => "icons/16x16",
+    #  :file_extend => '.png',
+    #  :spacing => 10,
+    #  :image_to_folder => "app/assets/images",
+    #  :image_source_folder => 'app/assets/images/rails_xxx/sprite_sources',
+    #  :stylesheet_to => "app/assets/stylesheets/rails_xxx/sprite/icons/16x16.css.scss.erb",
+    #  :image_to_file_path => "rails_xxx/sprite/icons/16x16.png"
+    #
+    def initialize options={}
+      @root_path                = options.fetch(:root_path, ::Rails.root)
+
+      @scope_name               = options.fetch(:scope_name, '')
+      @scope_name               = "#{scope_name}/" unless scope_name.end_with?('/')
+
+      @recipe_path              = options.fetch(:recipe_path, '')
+      @recipe_path              = recipe_path.chomp('/') if recipe_path.end_with?('/')
+
+      @file_extend              = options.fetch(:file_extend, '.png').downcase
+      @css_extend               = options.fetch(:css_extend, ".css.scss.erb")
+
+      @file_extend_name = file_extend.gsub('.', '')
+
+      @spacing                  = options.fetch(:spacing, 10)
+      @stylesheet_scope_name    = "#{scope_name}sprite/#{recipe_path}#{css_extend}"
+      @stylesheet_to            = options.fetch(:stylesheet_to, "#{root_path}/app/assets/stylesheets/#{stylesheet_scope_name}")
+
+      @image_source_folder      = options.fetch(
+        :image_source_folder, "#{root_path}/app/assets/images/#{scope_name}sprite_sources/#{recipe_path}"
+      )
+
+      @image_to_folder          = options.fetch(:image_to_folder, "#{root_path}/app/assets/images")
+      @image_scope_name         = "#{scope_name}sprite/#{recipe_path}#{file_extend}"
+      @image_to_file_path       = options.fetch(:image_to_file_path, "#{image_to_folder}/#{image_scope_name}")
+
+      @scope_str                = scope_name.chomp('/').gsub('/', '-')
+      @recipe_str               = recipe_path.chomp('/').gsub('/', '-')
+
+      @css_class_shared         = options.fetch(:css_class_shared, "rs-#{@scope_str}")
+      @css_class_prefix         = options.fetch(:css_class_prefix, "rs-#{@scope_str}-#{@recipe_str}-")
+    end
+
+    def perform
+      file_infos = []
+
+      #  puts "image_source_folder: #{image_source_folder}"
+      #  puts "image_to_file_path: #{image_to_file_path}"
+      #  puts "stylesheet_to: #{stylesheet_to}"
+
+      counter = 0
+
+      x = 0
+      y = 0
+      max_w = 0
+      max_h = 0
+
+      Dir.entries( image_source_folder ).each do |file_name|
+        if file_name != '.' && file_name != '..' && file_name.end_with?(file_extend)
+          file_path = "#{image_source_folder}/#{file_name}"
+
+          if ::File.file?( file_path )
+            # puts "#{file_path}"
+
+            file_name_split = file_name.split('.')
+            file_name_split.pop
+            file_purename = file_name_split.join('.')
+
+            file_info = {
+              :filepath => file_path,
+              :filename => file_name,
+              :file_purename => file_purename,
+              :idx => counter
+            }.merge(
+              _library.load( file_path )
+            )
+
+            file_info[:x] = x
+            file_info[:y] = y
+
+            y += ( spacing + file_info[:height] )
+
+            max_w = [max_w, file_info[:width]].max
+            max_h = y
+
+            file_infos << file_info
+
+            counter += 1
+          end
+        end
+      end
+
+      _composite_images( :file_infos => file_infos, :max_w => max_w, :max_h => max_h )
+      _composite_css( file_infos )
+    end
+
+    private
+
+    def stylesheet_generator
+      RailsSprite::StylesheetGenerator
+    end
+
+    def _library
+      RailsSprite::Library::RMagick
+    end
+
+    def _composite_css file_infos
+      stylesheet_generator.generate(
+        :css_class_shared => css_class_shared,
+        :css_class_prefix => css_class_prefix,
+        :file_infos => file_infos,
+        :image_scope_name => image_scope_name,
+        :css_extend => css_extend,
+        :stylesheet_to => stylesheet_to
+      )
+    end
+
+    def _composite_images options={}
+      target = Magick::Image.new(options[:max_w], options[:max_h])
+      target.opacity = Magick::QuantumRange
+
+      options[:file_infos].each do |file_info|
+        target.composite!(file_info[:image], file_info[:x], file_info[:y], Magick::SrcOverCompositeOp)
+      end
+
+      target.write(image_to_file_path)
+    end
+
+  end
+end

data/lib/rails_sprite/stylesheet_generator.rb

@@ -0,0 +1,85 @@
+module RailsSprite
+  class StylesheetGenerator
+
+    def self.generate options={}
+      css_class_prefix = options[:css_class_prefix]
+      css_class_shared = options[:css_class_shared]
+      css_extend = options[:css_extend] 
+      image_scope_name = options[:image_scope_name]
+      file_infos = options[:file_infos]
+      stylesheet_to = options[:stylesheet_to]
+
+      result = {}
+
+      styles = []
+
+      file_infos.each do |file_info|
+        style = {}
+
+        style[:width] = "#{file_info[:width]}px"
+        style[:height] = "#{file_info[:height]}px"
+        style[:x] = "#{file_info[:x]}px"
+        style[:y] = "#{file_info[:y]}px"
+        style[:class] = "#{css_class_prefix}#{file_info[:file_purename]}"
+
+        styles << style
+      end
+
+
+      result[:styles] = styles
+      result[:image_scope_name] = image_scope_name
+      result[:css_class_shared] = css_class_shared
+
+      # case css_extend
+      # when '.css.scss.erb'
+      # else
+      # end
+
+      system "mkdir -p #{::File.dirname(stylesheet_to)}"
+
+      ::File.open(stylesheet_to, 'w') do |file|
+        file.write( composite_css_scss_erb(result) )
+      end
+
+      result
+    end
+
+    def self.composite_css_scss_erb result
+      styles = []
+
+      styles << <<-END_CSS
+.#{result[:css_class_shared]} {
+  background: url(<%= image_path("#{result[:image_scope_name]}") %>) no-repeat;
+}
+      END_CSS
+
+      result[:styles].each do |style|
+        styles << <<-END_CSS
+.#{style[:class]} {
+  background-position: #{style[:x]} -#{style[:y]};
+}
+        END_CSS
+      end
+
+
+      styles.join("\n")
+    end
+
+    # def self.generate(style_name, selector, url, images)
+    #   styles = []
+    #   images.each do |image|
+    #     attr = [
+    #       "width: #{image[:cssw]}px",
+    #       "height: #{image[:cssh]}px",
+    #       "background: #{url} #{-image[:cssx]}px #{-image[:cssy]}px no-repeat"
+    #     ]
+    #     image[:selector] = selector                          # make selector available for (optional) custom rule generators
+    #     image[:style]    = send("#{style_name}_style", attr) # make pure style available for (optional) custom rule generators (see usage of yield inside Runner#style)
+    #     styles << send(style_name, selector, image[:name], attr)
+    #   end
+    #   styles << ""
+    #   styles.join("\n")
+    # end
+
+  end
+end

data/lib/rails_sprite/version.rb

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "rails-sprite"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end