technologist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64dec81accfcda79b977750e32b8bc61a96f7b61
-  data.tar.gz: b5fbc327799092308ac3765bef95c98bacc0bc56
+  metadata.gz: 0702a8fcc2a5cb321b18b1eeecd77fa506acaade
+  data.tar.gz: ee9bae10218646991f9c6368c863a1465b0a79ed
 SHA512:
-  metadata.gz: de3da25bc97325009cffc248612bc4498aab9ee8f15a235503962cd6147d7fa71d90835b9c329934af80a02d37b15a1c0c8ff80d169139ae25cab5fab14903a6
-  data.tar.gz: 5a6fa0cfa096ef7261590efecadfa7dd15a19e94cdfe46ea53c1777ef0b244ad717594926c9c814e23b9b96e19e0726f28e5ebc5f96553440f4e82dbe2b8f017
+  metadata.gz: 4bdf9f824a3a4437f7402ad55e1d99713d5bec201eaa8f8a67cace1b6b8457d450856f4ec046ec619ada9f5b5beed05fce252ba32d0323c02f29c6c00096d690
+  data.tar.gz: 971c2070f033c4483813779f786f5c114c60aa437570bc10ed402008df353700db69049934bc88a903979a8e04a14eeacbfcf132a5ba83e3e99a61b564cea012

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.0.0

data/lib/technologist.rb

@@ -1,5 +1,6 @@
 require 'technologist/version'
 require 'technologist/repository'
+Dir[File.expand_path('../technologist/rules/*.rb', __FILE__)].each { |file| require file }
 
 module Technologist
 end

data/lib/technologist/framework_detector.rb

@@ -34,13 +34,7 @@ module Technologist
         begin
           rules.map do |technology, definition|
             definition['rules'].map do |rule|
-              rule = rule.flatten
-              file_name = rule.first
-              pattern = rule.last
-              # may use single or double quotes
-              pattern = pattern.gsub(/["']/, %q{["']})
-
-              if repository.file_content(file_name) =~ /#{pattern}/
+              if rule.matches?(technology, repository)
                 technology
               end
             end

data/lib/technologist/frameworks.yml

@@ -1,26 +1,39 @@
-Locomotive:
+Rails:
   rules:
-    - Gemfile: ^\s*gem 'locomotivecms_wagon'
-  primary: Rails
+    - !ruby/object:GemRule {}
 
-Rails:
+Locomotive:
   rules:
-    - Gemfile: ^\s*gem 'rails'
+    - !ruby/object:GemRule { gem_name: 'locomotivecms_wagon' }
+  primary: Rails
 
 Magnolia:
   rules:
-    - pom.xml: <magnoliaVersion>
+    - !ruby/object:FileContentRule { file_name: 'pom.xml', file_content_pattern: '<magnoliaVersion>' }
 
 Sinatra:
   rules:
-    - config.ru: run Sinatra::Application
-    - Gemfile: ^\s*gem 'sinatra'
+    - !ruby/object:FileContentRule { file_name: 'config.ru', file_content_pattern: 'run Sinatra::Application' }
+    - !ruby/object:GemRule {}
 
 Dashing:
   rules:
-    - Gemfile: ^\s*gem 'dashing'
+    - !ruby/object:GemRule {}
   primary: Sinatra
 
 Middleman:
   rules:
-    - Gemfile: ^\s*gem 'middleman'
+    - !ruby/object:GemRule {}
+
+Meteor:
+  rules:
+    - !ruby/object:DirectoryPresenceRule { directory_name: '.meteor' }
+
+Spree:
+  rules:
+    - !ruby/object:GemRule { gem_name: 'spree' }
+  primary: Rails
+
+Wordpress:
+  rules:
+    - !ruby/object:FilePresenceRule { file_name: 'wp-settings.php' }

data/lib/technologist/git_repository.rb

@@ -18,30 +18,51 @@ module Technologist
     #
     # @return [String] The content of the file or nil if the file cannot be found.
     def file_content(file_name)
-      file = find_file(file_name)
+      file = find_blob(file_name)
 
       file.content if file
     end
 
-    # Recursively searches for the file identified by `file_name`
-    # in all subdirectories in the repository.
+    # Recursively searches for the blob identified by `blob_name`
+    # in all subdirectories in the repository. A blob is usually either
+    # a file or a directory.
     #
-    # @param file_name [String] the file name
-    # @param current_tree [Rugged::Tree] the git directory tree in which to look for the file.
+    # @param blob_name [String] the blob name
+    # @param current_tree [Rugged::Tree] the git directory tree in which to look for the blob.
     #   Defaults to the root tree (see `#root_tree`).
     #
-    # @return [Rugged::Blob] The file blob or nil if it cannot be found.
-    def find_file(file_name, current_tree = root_tree)
-      file = current_tree[file_name]
+    # @return [Rugged::Blob] The blob blob or nil if it cannot be found.
+    def find_blob(blob_name, current_tree = root_tree)
+      blob = current_tree[blob_name]
 
-      if file
-        repository.lookup(file[:oid])
+      if blob
+        repository.lookup(blob[:oid])
       else
         current_tree.each_tree do |sub_tree|
-          file = find_file(file_name, repository.lookup(sub_tree[:oid]))
-          break file if file
+          blob = find_blob(blob_name, repository.lookup(sub_tree[:oid]))
+          break blob if blob
         end
       end
     end
+
+    # Looks for a directory and returns true when the directory
+    # can be found.
+    #
+    # @param directory_name [String] the directory name
+    #
+    # @return [Boolean] true if the directory can be found.
+    def directory_exists?(directory_name)
+      !!find_blob(directory_name)
+    end
+
+    # Looks for a file and returns true when the file
+    # can be found.
+    #
+    # @param file_name [String] the file name
+    #
+    # @return [Boolean] true if the file can be found.
+    def file_exists?(file_name)
+      !!find_blob(file_name)
+    end
   end
 end

data/lib/technologist/rules/directory_presence_rule.rb

@@ -0,0 +1,9 @@
+require 'technologist/rules/rule'
+
+class DirectoryPresenceRule < Rule
+  attr_accessor :directory_name
+
+  def matches?(framework_name, repository)
+    repository.directory_exists?(directory_name)
+  end
+end

data/lib/technologist/rules/file_content_rule.rb

@@ -0,0 +1,9 @@
+require 'technologist/rules/rule'
+
+class FileContentRule < Rule
+  attr_accessor :file_name, :file_content_pattern
+
+  def matches?(framework_name, repository)
+    !!(repository.file_content(file_name) =~ /#{file_content_pattern}/)
+  end
+end

data/lib/technologist/rules/file_presence_rule.rb

@@ -0,0 +1,9 @@
+require 'technologist/rules/rule'
+
+class FilePresenceRule < Rule
+  attr_accessor :file_name
+
+  def matches?(framework_name, repository)
+    repository.file_exists?(file_name)
+  end
+end

data/lib/technologist/rules/gem_rule.rb

@@ -0,0 +1,13 @@
+require 'technologist/rules/file_content_rule'
+
+class GemRule < FileContentRule
+  attr_accessor :gem_name
+
+  def matches?(framework_name, repository)
+    self.file_name = 'Gemfile'
+    self.gem_name ||= framework_name.downcase
+    self.file_content_pattern = /^\s*gem ["']#{gem_name}["']/
+
+    super
+  end
+end

data/lib/technologist/rules/rule.rb

@@ -0,0 +1,9 @@
+class Rule
+  def initialize(attributes = {})
+    attributes.each { |name, value| self.send(:"#{name}=", value) }
+  end
+
+  def matches?(framework_name, repository)
+    false
+  end
+end

data/lib/technologist/version.rb

@@ -1,3 +1,3 @@
 module Technologist
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/technologist.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |spec|
   spec.email         = ["mail@koffeinfrei.org"]
 
   spec.summary       = %q{Detects the technologies used in a repository.}
-  spec.description   = %q{}
+  spec.description   = %q{Detects technologies in a repository by applying a set of rules and returning primary and secondary frameworks.}
   spec.homepage      = "https://github.com/github/koffeinfrei/linguist"
+  spec.license       = "AGPL-3.0"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
@@ -22,5 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: technologist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexis Reigel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -58,15 +58,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
-description: ''
+        version: '3.3'
+description: Detects technologies in a repository by applying a set of rules and returning
+  primary and secondary frameworks.
 email:
 - mail@koffeinfrei.org
 executables: []
@@ -88,10 +89,16 @@ files:
 - lib/technologist/frameworks.yml
 - lib/technologist/git_repository.rb
 - lib/technologist/repository.rb
+- lib/technologist/rules/directory_presence_rule.rb
+- lib/technologist/rules/file_content_rule.rb
+- lib/technologist/rules/file_presence_rule.rb
+- lib/technologist/rules/gem_rule.rb
+- lib/technologist/rules/rule.rb
 - lib/technologist/version.rb
 - technologist.gemspec
 homepage: https://github.com/github/koffeinfrei/linguist
-licenses: []
+licenses:
+- AGPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []