trufflepig 0.2.5 → 0.2.6

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Sebastian Kippe
+Copyright (c) 2012 Appcache Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,53 @@
 [![Build Status](https://secure.travis-ci.org/5apps/trufflepig.png?branch=master)](http://travis-ci.org/5apps/trufflepig)
 
-Scans files and directories for scrummy truffles. And by truffles, we mean shiny new features of HTML5, JavaScript APIs, CSS3, and friends. Obviously.
+Scans files and directories for scrummy truffles. And by truffles, we mean
+shiny new features of HTML5, JavaScript APIs, CSS3, and friends. Obviously.
+
+![Truffle pigs](http://5apps-assets.s3.amazonaws.com/trufflepig/trufflepig.png)
+
+## Usage
+
+```ruby
+gem 'trufflepig', :require => 'trufflepig'
+```
+
+Send the truffle pig on its way:
+
+```ruby
+search = Trufflepig::Search.new "path/to/file/or/directory"
+search.perform
+```
+
+Then look what it found:
+
+```ruby
+search.results
+```
+
+The results will consist of an array of feature objects, formatted exactly like
+the caniuse.com/html5please.com source data, containing a description of the
+feature as well as browser compatibility tables, and links to more info.
+
+## Adding or updating detection patterns
+
+Add or update patterns with the correct caniuse.com key to
+[data/patterns.json](https://github.com/5apps/trufflepig/blob/master/data/patterns.json).
+The build task will merge that list with the source JSON and create
+data/features.json which will be used by the search:
+
+```
+rake featurelist:build
+```
+
+## To do
+
+* Respect filetypes when scanning for features (e.g. don't look for CSS
+  features in HTML code)
+* Command line interface
+* ...
 
 ## License
 
-This gem is licensed under the MIT license. The feature data is originally from [caniuse.com](http://caniuse.com) and published under the [CC BY-NC 3.0 license](http://creativecommons.org/licenses/by-nc/3.0/).
+This gem is licensed under the MIT license. The feature data is originally from
+[caniuse.com](http://caniuse.com) and published under the [CC BY-NC 3.0
+license](http://creativecommons.org/licenses/by-nc/3.0/).

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/lib/trufflepig/search.rb

@@ -2,7 +2,10 @@ module Trufflepig
   class Search
     attr_accessor :results, :path
 
-    EXCLUDED_FILENAMES = /jquery|prototype|yui|dojo|extjs|raphael|zepto|enyo|ember/
+    EXCLUDED_FILENAMES = /#{%w{
+      jquery prototype yui dojo extjs raphael zepto enyo ember modernizr
+      bootstrap foundation
+    }.join('|')}/
 
     def initialize(path)
       @results = []

data/spec/trufflepig/search_spec.rb

@@ -34,7 +34,7 @@ describe Trufflepig::Search do
         end
       end
 
-      describe "a well-known JS lib file" do
+      describe "a well-known JS or CSS lib file" do
         before do
           @search = Trufflepig::Search.new "#{dummy_app_path}/js/jquery.js"
           @search.perform

data/trufflepig.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "trufflepig"
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sebastian Kippe", "Garret Alfert"]
-  s.date = "2012-04-04"
+  s.date = "2012-04-05"
   s.description = "Detects Web platform feature usage in source files"
   s.email = "rubygems@5apps.com"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trufflepig
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-04 00:00:00.000000000 Z
+date: 2012-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: purdytest
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1419909812854099826
+      hash: 3974065047902269502
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: