sniffux 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sniffux.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simon George
+
+MIT License
+
+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,40 @@
+# Sniffux
+
+Use user-agent string to reason about UX expectations. E.g. Should the Cancel button in dialigues be on the left or the right? You may then use this information to serve your users a version of your site that matches their expectations and is consistent with the UX they are used to.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sniffux'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sniffux
+
+## Usage
+
+Rails:
+
+    <div id="alert" class="cancel-on-#{sniffux.cancel_side}">
+
+Other framework:
+
+    sniffux = Sniffux.new(request.user_agent)
+    if sniffux.cancel_left?
+      'Cancel button is on the left!!1'
+    else
+      'Cancel button is on the anti-left xoxo'
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sniffux.rb

@@ -0,0 +1,69 @@
+require "sniffux/version"
+require "user_agent"
+
+class Sniffux
+  # Add Rails helper if ActionController::Base is available
+  require "sniffux/action_controller" if defined?(ActionController::Base)
+  
+  def initialize(string)
+    @user_agent = UserAgent.parse(string)
+  end
+
+  def cancel_left?
+    # OS X, iOS, Linux, ChromeOS, WebOS, Haiku
+    # Default because it's better:
+    # http://uxmovement.com/buttons/why-ok-buttons-in-dialog-boxes-work-best-on-the-right/
+    !cancel_right?
+  end
+  
+  def cancel_right?
+    # Windows, Android, Amiga (AROS)
+    %w(Windows).include?(@user_agent.platform) ||
+    %w(AROS).include?(@user_agent.os) ||
+    !!(@user_agent.os =~ /Android/)
+  end
+  
+  def cancel_side
+    if cancel_right?
+      'right'
+    else
+      'left'
+    end
+  end
+  
+  def ok_left?
+    cancel_right?
+  end
+  
+  def ok_right?
+    cancel_left?
+  end
+  
+  def ok_side
+    if ok_right?
+      'right'
+    else
+      'left'
+    end
+  end
+  
+  def close_left?
+    # OS X, iOS, Linux (Ubuntu, can vary), Haiku, Amiga
+    # Default because it matches having Cancel on the left
+    !close_right?
+  end
+  
+  def close_right?
+    # Windows, ChromeOS
+    %w(Windows).include?(@user_agent.platform) ||
+    !!(@user_agent.os =~ /CrOS/)
+  end
+  
+  def close_side
+    if close_right?
+      'right'
+    else
+      'left'
+    end
+  end
+end

data/lib/sniffux/action_controller.rb

@@ -0,0 +1,19 @@
+class Sniffux
+  module ActionController # :nodoc: all
+    def self.included(base)
+      base.send :helper_method, :browser
+    end
+
+    private
+    def sniffux
+      @sniffux ||= Sniffux.new(
+        #:accept_language => request.headers["Accept-Language"],
+        #:ua => request.headers["User-Agent"]
+        
+        request.user_agent
+      )
+    end
+  end
+end
+
+ActionController::Base.send :include, Browser::ActionController

data/lib/sniffux/version.rb

@@ -0,0 +1,3 @@
+class Sniffux
+  VERSION = "0.0.1"
+end

data/sniffux.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sniffux/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sniffux"
+  gem.version       = Sniffux::VERSION
+  gem.authors       = ["Simon George"]
+  gem.email         = ["simon@sfcgeorge.co.uk"]
+  gem.description   = %q{Use user-agent string to reason about UX expectations. E.g. Should the Cancel button in dialigues be on the left or the right?}
+  gem.summary       = %q{Reason about UX expectations.}
+  gem.homepage      = "http://www.sfcgeorge.co.uk/posts/2013/04/20/enhancing-web-ux-consistency-sniffux"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_runtime_dependency "useragent", "~> 0.5.0"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: sniffux
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simon George
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: useragent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Use user-agent string to reason about UX expectations. E.g. Should the
+  Cancel button in dialigues be on the left or the right?
+email:
+- simon@sfcgeorge.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sniffux.rb
+- lib/sniffux/action_controller.rb
+- lib/sniffux/version.rb
+- sniffux.gemspec
+homepage: http://www.sfcgeorge.co.uk/posts/2013/04/20/enhancing-web-ux-consistency-sniffux
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Reason about UX expectations.
+test_files: []