crispy-mobile 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Christian Peters
+
+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,67 @@
+# Crispy Mobile
+
+## What does it do?
+
+Crispy Mobile empowers your Rails application with easy-accessible device-detection.
+In your controller or view, you can access device properties or add switches like:
+
+``` haml
+- if device == :desktop
+  = stylesheet_link_tag :desktop
+- else
+  = stylesheet_link_tag :mobile
+
+= image_tag @photo.dynamic_url(device > :handheld_480 ? '600x400' : '300x200')
+
+= image_tag @photo.dynamic_url("#{device.display_width}x")
+```
+
+## Why should my app be responsive on the server side?
+
+CSS media queries are nice. But not for mobile.
+
+They just add up code you send to your clients instead of reducing it
+for mobile devices.
+
+Imagine you want to make a responsive product page.
+
+* Do you really want to deliver a big 90KB product photo, if a
+  15KB photo would already fill the mobile screen?
+* Do you really want to compute personalized product recommendations if
+  they are just hidden afterwards?
+* Do you really want mobile devices to download and interpret your whole
+  stylesheet if half of the interface elements are going to be hidden anyway?
+
+You don't.
+
+If you start mobile-first, don't let your mobile performance be affected by
+additional desktop features.
+
+Be kind, serve the clients exactly what they need.
+
+### How is it done?
+
+A middleware is introduced which looks up the user agent string in the
+[WURFL repository](http://wurfl.sourceforge.net/).
+
+## Usage
+
+Pending. Please have a look at the source.
+
+## Installation
+
+In your Gemfile add:
+
+``` ruby
+  gem 'crispy-mobile'
+```
+
+In your ApplicationController add:
+
+``` ruby
+  include Crispy::DeviceHelpers
+```
+
+## License
+
+See MIT-LICENSE.

data/lib/crispy-mobile/device.rb

@@ -0,0 +1,47 @@
+module Crispy
+
+  class Device
+    include Comparable
+
+    attr_accessor :profile
+    attr_accessor :display_width
+
+    SUPPORTED_DISPLAY_WIDTHS = {handheld_320: 320, handheld_640: 640, desktop: 950}
+
+    def initialize(profile)
+      self.profile = profile
+      self.display_width = profile.resolution_width
+    end
+
+    def to_s
+      profile[:id]
+    end
+
+    def <=>(other)
+      raise "Comparison of devices failed. Tried to compare #{self} with nil." if other.nil?
+
+      other_width = if other.respond_to? :display_width
+        other.display_width
+      elsif other.respond_to?(:to_i) && other.to_i.integer?
+        other.to_i
+      elsif SUPPORTED_DISPLAY_WIDTHS.has_key? other
+        SUPPORTED_DISPLAY_WIDTHS[other]
+      end
+
+      raise "Comparison of devices failed. No valid display_width can be infered from #{other}." unless other_width && other_width > 0
+      display_width <=> other_width
+    end
+  end
+
+  class DesktopDevice < Device
+    def initialize(profile = WURFL::Hash.new)
+      profile.reverse_merge! resolution_width: display_width, id: 'desktop'
+      super(profile)
+    end
+
+    def display_width
+      SUPPORTED_DISPLAY_WIDTHS[:desktop] || 1024
+    end
+  end
+
+end

data/lib/crispy-mobile/helpers.rb

@@ -0,0 +1,19 @@
+module Crispy
+
+  module DeviceHelpers
+
+    def device
+      if request.env['WURFL'].nil?
+        @device ||= DesktopDevice.new
+      else
+        @device ||= Device.new(request.env['WURFL'])
+      end
+    end
+
+    ActiveSupport.on_load(:action_controller) do
+      helper_method :device
+    end
+
+  end
+
+end

data/lib/crispy-mobile/railtie.rb

@@ -0,0 +1,9 @@
+require 'wurfl-lite-middleware'
+
+module CrispyMobile
+  class Railtie < Rails::Railtie
+    initializer "crispy_mobile.use_middleware" do |app|
+      app.middleware.use WURFL::Middleware
+    end
+  end
+end

data/lib/crispy-mobile.rb

@@ -0,0 +1,4 @@
+require 'crispy-mobile/railtie' if defined?(Rails)
+
+require 'crispy-mobile/device'
+require 'crispy-mobile/helpers'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: crispy-mobile
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christian Peters
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-18 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: wurfl-lite-middleware
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 0
+        - 6
+        version: 1.0.6
+  type: :runtime
+  version_requirements: *id001
+description: CSS Media Requeries are a nice idea but don't cut down payload size. Serve only what is needed for each device. This gem lets you access device information in a Rails controller/view. Now be really responsive!
+email: info@c-peters.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- MIT-LICENSE
+- lib/crispy-mobile/device.rb
+- lib/crispy-mobile/helpers.rb
+- lib/crispy-mobile/railtie.rb
+- lib/crispy-mobile.rb
+has_rdoc: true
+homepage: https://github.com/ChristianPeters/crispy-mobile
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Crispy Mobile tells you which device requests your Rails page. Be responsive on the server side!
+test_files: []
+