mobvious-rails 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle
+/.yardoc
+/doc
+/Gemfile.lock
+/tmp
+/vendor/ruby

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gemspec
+
+
+
+# == SPECIAL DEVELOPMENT DEPS HANDLING ==
+
+# temporarily switched for this fork, because the current version of guard-minitest has broken notifications
+gem 'guard-minitest', git: 'git://github.com/aspiers/guard-minitest', ref: '4b660261d35'
+
+gem 'mobileesp', git: 'git://github.com/jistr/mobileesp'
+gem 'mobvious', git: 'git://github.com/jistr/mobvious', branch: 'develop'
+# gem 'mobvious', path: '../mobvious' # for development
+gem 'mocha', require: false
+gem 'turn', require: false

data/Guardfile

@@ -0,0 +1,24 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end
+
+guard 'coffeescript', output: 'tmp/javascripts-compiled', hide_success: true do
+  watch(/^app\/assets\/javascripts\/(.*).coffee/)
+end
+
+guard 'coffeescript', output: 'tmp/spec-javascripts-compiled', hide_success: true do
+  watch(/^spec\/javascripts\/(.*).coffee/)
+
+  # FIXME: tests run for each compiled file, should run only once
+  callback(:run_all_end) do
+    `rake jasmine:ci`
+    if $? == 0
+      ::Guard::Notifier.notify('CoffeeScript tests passed.', { title: 'CoffeeScript tests' })
+    else
+      ::Guard::Notifier.notify('CoffeeScript tests failed.', { title: 'CoffeeScript tests', image: :failed })
+    end
+  end
+end
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/app/assets/javascripts/mobvious-rails.js.coffee

@@ -0,0 +1,11 @@
+if window.Mobvious == undefined
+  window.Mobvious = {}
+
+Mobvious.for_device_type = (args...) ->
+  callback_fn = args[args.length - 1]
+  wanted_device_types = args[0..(args.length - 2)]
+
+  for wanted_device_type in wanted_device_types
+    return callback_fn() if Mobvious.device_type == wanted_device_type
+
+  null

data/lib/mobvious/rails.rb

@@ -0,0 +1,14 @@
+require "mobvious/rails/version"
+
+require "mobvious/rails/controller"
+require "mobvious/rails/engine"
+require "mobvious/rails/helper"
+
+module Mobvious
+  # Mobvious::Rails is a helper library to ease development in Rails when using
+  # the Mobvious library to detect client device types.
+  #
+  # It provides basic controller and view extensions and some CoffeeScript helpers.
+  module Rails
+  end
+end

data/lib/mobvious/rails/controller.rb

@@ -0,0 +1,41 @@
+module Mobvious
+module Rails
+  # A module holding Rails controller extensions.
+  #
+  # Just put `include Mobvious::Rails::Controller` into your `ApplicationController`.
+  module Controller
+    # Executes a block of code only when a request was made by a given client device type.
+    #
+    # Example:
+    #
+    #     for_device_type :mobile do
+    #       logger.info "This gets executed only for mobile phones."
+    #     end
+    #
+    # @param wanted_device_type a symbol identifying a device type
+    # @yield a block to execute if the specified device type matches device type of the
+    #   current request
+    # @return value that the yielded block returns, or nil if it didn't get executed
+    def for_device_type(*wanted_device_types)
+      unless block_given?
+        raise ArgumentError, "Device helper takes a block of code to execute for given device."
+      end
+
+      unless device_type
+        raise "Mobvious device type not set. Did you add the Mobvious rack middleware?"
+      end
+
+      if wanted_device_types.include? device_type
+        yield
+      else
+        nil
+      end
+    end
+
+    # @return [Symbol] device type for current request
+    def device_type
+      request.env['mobvious.device_type']
+    end
+  end
+end
+end

data/lib/mobvious/rails/engine.rb

@@ -0,0 +1,8 @@
+module Mobvious
+module Rails
+  # Definition of this class makes it a Rails engine, enabling this library
+  # to provide assets can be used in the application.
+  class Engine < ::Rails::Engine
+  end
+end
+end

data/lib/mobvious/rails/helper.rb

@@ -0,0 +1,67 @@
+module Mobvious
+module Rails
+  # A module holding Rails view helper extensions.
+  #
+  # Just put `include Mobvious::Rails::Helper` into your `ApplicationHelper`.
+  module Helper
+    # Executes a block of code only when a request was made by a given client device type.
+    #
+    # Example:
+    #
+    #     <% for_device_type :mobile do %>
+    #       <p>This gets rendered only on mobile phones.</p>
+    #     <% end %>
+    #
+    # @param wanted_device_type a symbol identifying a device type
+    # @yield a block to execute if the specified device type matches device type of the
+    #   current request
+    # @return value that the yielded block returns, or nil if it didn't get executed
+    def for_device_type(*wanted_device_types)
+      unless block_given?
+        raise ArgumentError, "Device helper takes a block of content to render for given device."
+      end
+
+      unless device_type
+        raise "Mobvious device type not set. Did you add the Mobvious rack middleware?"
+      end
+
+      if wanted_device_types.include? device_type
+        yield
+      else
+        nil
+      end
+    end
+
+    # @return [Symbol] device type for current request
+    def device_type
+      request.env['mobvious.device_type']
+    end
+
+    # Forms a `<script>` tag setting JavaScript variable `window.Mobvious.device_type`
+    # to a string holding current request's device type. You can then use
+    # `Mobvious.device_type` in all your JavaScripts to get this value.
+    #
+    # Example:
+    #
+    #     <head>
+    #       <%= mobvious_javascript %>
+    #
+    #       <script type="text/javascript">
+    #         alert(Mobvious.device_type); // this will print 'mobile' or 'desktop' or similar
+    #       </script>
+    #     </head>
+    #
+    # @return [String] script tag that sets Mobvious variables (returned string is html_safe)
+    def mobvious_javascript
+      <<-END.html_safe
+        <script type="text/javascript">
+        if (window.Mobvious === undefined) {
+          window.Mobvious = {};
+        }
+        window.Mobvious.device_type = '#{device_type.to_s}';
+        </script>
+      END
+    end
+  end
+end
+end

data/lib/mobvious/rails/version.rb

@@ -0,0 +1,5 @@
+module Mobvious
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/mobvious-rails.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mobvious/rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mobvious-rails"
+  s.version     = Mobvious::Rails::VERSION
+  s.authors     = ["Jiří Stránský"]
+  s.email       = ["jistr@jistr.com"]
+  s.homepage    = "http://github.com/jistr/mobvious-rails"
+  s.summary     = %q{Rails enhancements for rendering different content for different device types}
+  s.description = %q{Rails enhancements for rendering different content for different device types}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "mobvious"
+  s.add_runtime_dependency "activesupport"
+
+
+  # == DEVELOPMENT DEPENDENCIES ==
+  # Smart irb
+  s.add_development_dependency 'pry'
+
+  # Specs
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+
+  # CoffeeScript compilation and testing
+  s.add_development_dependency 'therubyracer'
+  s.add_development_dependency 'jasmine'
+
+  # Running tests during development
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency 'guard-coffeescript'
+  # Linux Guard watching
+  s.add_development_dependency 'rb-inotify'
+  # Linux Guard notifications
+  s.add_development_dependency 'libnotify'
+
+  # Pretty printed test output
+  s.add_development_dependency 'turn'
+end

data/spec/javascripts/mobvious-rails_spec.js.coffee

@@ -0,0 +1,34 @@
+describe 'Mobvious', ->
+  beforeEach ->
+    window.Mobvious = {} if window.Mobvious == undefined
+    window.Mobvious.device_type = 'mobile'
+
+  describe 'for_device_type', ->
+    it 'should run only for the right device types', ->
+      mobile_block_executed = false
+      desktop_block_executed = false
+      multiple_block_executed = false
+
+      mobile_retval = Mobvious.for_device_type 'mobile', ->
+        mobile_block_executed = true
+        'mobile_retval'
+      expect(mobile_block_executed).toEqual true
+      expect(mobile_retval).toEqual 'mobile_retval'
+
+      desktop_retval = Mobvious.for_device_type 'desktop', ->
+        desktop_block_executed = true
+        'desktop_retval'
+      expect(desktop_block_executed).toEqual false
+      expect(desktop_retval).toEqual null
+
+      multiple_retval = Mobvious.for_device_type 'desktop', 'tablet', ->
+        multiple_block_executed = true
+        'multiple_retval'
+      expect(multiple_block_executed).toEqual false
+      expect(multiple_retval).toEqual null
+
+      multiple_retval = Mobvious.for_device_type 'desktop', 'mobile', ->
+        multiple_block_executed = true
+        'multiple_retval'
+      expect(multiple_block_executed).toEqual true
+      expect(multiple_retval).toEqual 'multiple_retval'

data/spec/javascripts/support/jasmine.yml

@@ -0,0 +1,74 @@
+# src_files
+#
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_files:
+    - '**/*.js'
+
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:
+
+# spec_files
+#
+#  Return an array of filepaths relative to spec_dir to include.
+# Default: ["**/*[sS]pec.js"]
+#
+# EXAMPLE:
+#
+# spec_files:
+#   - **/*[sS]pec.js
+#
+spec_files:
+    - '**/*_spec.js'
+
+# src_dir
+#
+# Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+# Default: project root
+#
+# EXAMPLE:
+#
+# src_dir: public
+#
+src_dir: tmp/javascripts-compiled
+
+# spec_dir
+#
+# Spec directory path. Your spec_files must be returned relative to this path.
+# Default: spec/javascripts
+#
+# EXAMPLE:
+#
+# spec_dir: spec/javascripts
+#
+spec_dir: tmp/spec-javascripts-compiled

data/spec/javascripts/support/jasmine_config.rb

@@ -0,0 +1,23 @@
+module Jasmine
+  class Config
+
+    # Add your overrides or custom config code here
+
+  end
+end
+
+
+# Note - this is necessary for rspec2, which has removed the backtrace
+module Jasmine
+  class SpecBuilder
+    def declare_spec(parent, spec)
+      me = self
+      example_name = spec["name"]
+      @spec_ids << spec["id"]
+      backtrace = @example_locations[parent.description + " " + example_name]
+      parent.it example_name, {} do
+        me.report_spec(spec["id"])
+      end
+    end
+  end
+end

data/spec/javascripts/support/jasmine_runner.rb

@@ -0,0 +1,32 @@
+$:.unshift(ENV['JASMINE_GEM_PATH']) if ENV['JASMINE_GEM_PATH'] # for gem testing purposes
+
+require 'rubygems'
+require 'jasmine'
+jasmine_config_overrides = File.expand_path(File.join(File.dirname(__FILE__), 'jasmine_config.rb'))
+require jasmine_config_overrides if File.exist?(jasmine_config_overrides)
+if Jasmine::Dependencies.rspec2?
+  require 'rspec'
+else
+  require 'spec'
+end
+
+jasmine_config = Jasmine::Config.new
+spec_builder = Jasmine::SpecBuilder.new(jasmine_config)
+
+should_stop = false
+
+if Jasmine::Dependencies.rspec2?
+  RSpec.configuration.after(:suite) do
+    spec_builder.stop if should_stop
+  end
+else
+  Spec::Runner.configure do |config|
+    config.after(:suite) do
+      spec_builder.stop if should_stop
+    end
+  end
+end
+
+spec_builder.start
+should_stop = true
+spec_builder.declare_suites

data/spec/mobvious/rails/controller_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'mobvious/rails/controller'
+
+module Mobvious
+module Rails
+class ControllerSpec < MiniTest::Spec
+  describe Controller do
+    before do
+      @env = mock 'env'
+      @env.stubs('[]').with('mobvious.device_type').returns(:mobile)
+
+      @request = mock 'request'
+      @request.stubs(:env).returns(@env)
+      mock_request = @request
+
+      @controller = Object.new
+      @controller.extend Controller
+      @controller.define_singleton_method(:request) do
+        mock_request
+      end
+    end
+
+    it "runs the provided block only for corresponding device type" do
+      mobile_block_executed = false
+      desktop_block_executed = false
+      multiple_block_executed = false
+
+      mobile_retval = @controller.for_device_type :mobile do
+        mobile_block_executed = true
+        :mobile_retval
+      end
+      mobile_block_executed.must_equal true
+      mobile_retval.must_equal :mobile_retval
+
+      desktop_retval = @controller.for_device_type :desktop do
+        desktop_block_executed = true
+        :desktop_retval
+      end
+      desktop_block_executed.must_equal false
+      desktop_retval.must_equal nil
+
+      multiple_retval = @controller.for_device_type :desktop, :tablet do
+        multiple_block_executed = true
+        :multiple_retval
+      end
+      multiple_block_executed.must_equal false
+      multiple_retval.must_equal nil
+
+      multiple_retval = @controller.for_device_type :desktop, :mobile do
+        multiple_block_executed = true
+        :multiple_retval
+      end
+      multiple_block_executed.must_equal true
+      multiple_retval.must_equal :multiple_retval
+    end
+
+    it "returns current device type" do
+      @controller.device_type.must_equal :mobile
+    end
+  end
+end
+end
+end

data/spec/mobvious/rails/helper_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'mobvious/rails/helper'
+
+module Mobvious
+module Rails
+class HelperSpec < MiniTest::Spec
+  describe Helper do
+    before do
+      @env = mock 'env'
+      @env.stubs('[]').with('mobvious.device_type').returns(:mobile)
+
+      @request = mock 'request'
+      @request.stubs(:env).returns(@env)
+      mock_request = @request
+
+      @helper = Object.new
+      @helper.extend Helper
+      @helper.define_singleton_method(:request) do
+        mock_request
+      end
+    end
+
+    it "runs the provided block only for corresponding device type" do
+      mobile_block_executed = false
+      desktop_block_executed = false
+      multiple_block_executed = false
+
+      mobile_retval = @helper.for_device_type :mobile do
+        mobile_block_executed = true
+        :mobile_retval
+      end
+      mobile_block_executed.must_equal true
+      mobile_retval.must_equal :mobile_retval
+
+      desktop_retval = @helper.for_device_type :desktop do
+        desktop_block_executed = true
+        :desktop_retval
+      end
+      desktop_block_executed.must_equal false
+      desktop_retval.must_equal nil
+
+      multiple_retval = @helper.for_device_type :desktop, :tablet do
+        multiple_block_executed = true
+        :multiple_retval
+      end
+      multiple_block_executed.must_equal false
+      multiple_retval.must_equal nil
+
+      multiple_retval = @helper.for_device_type :desktop, :mobile do
+        multiple_block_executed = true
+        :multiple_retval
+      end
+      multiple_block_executed.must_equal true
+      multiple_retval.must_equal :multiple_retval
+    end
+
+    it "returns current device type" do
+      @helper.device_type.must_equal :mobile
+    end
+
+    it "generates javascript tag with device type" do
+      device_type_assignment = /window.Mobvious.device_type = 'mobile';/
+      @helper.mobvious_javascript.must_match device_type_assignment
+      @helper.mobvious_javascript.must_be :'html_safe?'
+    end
+  end
+end
+end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+begin; require 'turn'; rescue LoadError; end
+require 'mocha'
+
+require 'active_support/core_ext/string/output_safety'

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: mobvious-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jiří Stránský
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mobvious
+  requirement: &7091660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7091660
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &7088280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7088280
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &7115160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7115160
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &7114700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7114700
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &7114180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7114180
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  requirement: &7113560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7113560
+- !ruby/object:Gem::Dependency
+  name: jasmine
+  requirement: &7112840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7112840
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &7111080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7111080
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: &7109940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7109940
+- !ruby/object:Gem::Dependency
+  name: guard-coffeescript
+  requirement: &7109200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7109200
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &7124820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7124820
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: &7123860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7123860
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &7123000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7123000
+description: Rails enhancements for rendering different content for different device
+  types
+email:
+- jistr@jistr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- Guardfile
+- Rakefile
+- app/assets/javascripts/mobvious-rails.js.coffee
+- lib/mobvious/rails.rb
+- lib/mobvious/rails/controller.rb
+- lib/mobvious/rails/engine.rb
+- lib/mobvious/rails/helper.rb
+- lib/mobvious/rails/version.rb
+- mobvious-rails.gemspec
+- spec/javascripts/mobvious-rails_spec.js.coffee
+- spec/javascripts/support/jasmine.yml
+- spec/javascripts/support/jasmine_config.rb
+- spec/javascripts/support/jasmine_runner.rb
+- spec/mobvious/rails/controller_spec.rb
+- spec/mobvious/rails/helper_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jistr/mobvious-rails
+licenses: []
+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: 2203145114535676296
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2203145114535676296
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rails enhancements for rendering different content for different device types
+test_files: []