technologist 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2378b10dae9e8be8a3a908670493e515b460d703
-  data.tar.gz: 97fa566a3d4d81b5b19a6dbac8b22520cf066299
+  metadata.gz: 28a3182ef7ef764fb494a4531ce1060151420944
+  data.tar.gz: c895b0a90fb072bc2b35545e335d88ed2549b422
 SHA512:
-  metadata.gz: c9fe126a1345093b72fb02131f99b09d533acd2fe34db60102062cf66b77f5f931497bd5d2506b0726a7e756188a002b27916d502c087f1034ba13298661c185
-  data.tar.gz: 1f447477bbba87d7d84caa8d9ec7dfafbc7cc283772451cae00912ea17969155779eeb2d40021e67adec77598f782c06fb96223cef7a22abd6daf533fc8a867c
+  metadata.gz: 39af217cc9fd4cd46e5d4681550603f14a7499b846df3d2f9174970b7835df4205f22da59502059a15d6f9149e4c6481ede1196cab595df979b1645bd16e273d
+  data.tar.gz: 641c27183e4f540c84ee6bc1c28ecad335bbe8d5817693542180ba865096692933cc9129ed9c6aea64ce280332382ea0fed71448649494908f4a68cda9a43d28

data/lib/technologist/framework_detector.rb

@@ -1,42 +1,39 @@
-require 'yaml'
+require 'technologist/yaml_parser'
 
 module Technologist
   class FrameworkDetector
     FRAMEWORK_RULES = File.expand_path('../frameworks.yml',  __FILE__)
 
+    attr_reader :repository, :yaml_parser
+
     def initialize(repository)
       @repository = repository
+      @yaml_parser = YamlParser.new(FRAMEWORK_RULES)
     end
 
     def primary_frameworks
       matched_frameworks.map do |technology|
         # it's either the primary value defined in the yaml
         # or the technology itself
-        rules[technology]['primary'] || technology
+        yaml_parser.rules[technology]['primary'] || technology
       end.uniq
     end
 
     def secondary_frameworks
       matched_frameworks.map do |technology|
         # it's a secondary if a primary is defined in the yaml
-        rules[technology]['primary'] && technology
+        yaml_parser.rules[technology]['primary'] && technology
       end.compact
     end
 
     private
 
-    attr_reader :repository
-
-    def rules
-      @rules ||= YAML.load_file(FRAMEWORK_RULES)
-    end
-
     def matched_frameworks
       @frameworks ||=
         begin
-          rules.map do |technology, definition|
+          yaml_parser.rules.map do |technology, definition|
             definition['rules'].map do |rule|
-              if rule.matches?(technology, repository)
+              if rule.matches?(repository)
                 technology
               end
             end

data/lib/technologist/frameworks.yml

@@ -1,91 +1,142 @@
 Rails:
   rules:
-    - !ruby/object:GemRule {}
-    - !ruby/object:GemRule { gem_name: 'jrails' }
-    - !ruby/object:FileContentRule { file_name: 'boot.rb', file_content_pattern: 'Rails.boot!' }
+    - Gem
+    - Gem:
+      gem_name: 'jrails'
+    - FileContent:
+      file_name: 'boot.rb'
+      file_content_pattern: 'Rails.boot!'
 
 Locomotive:
   rules:
-    - !ruby/object:GemRule { gem_name: 'locomotivecms_wagon' }
+    - Gem:
+      gem_name: 'locomotivecms_wagon'
   primary: Rails
 
 Magnolia:
   rules:
-    - !ruby/object:FileContentRule { file_name: 'pom.xml', file_content_pattern: '<magnoliaVersion>' }
+    - FileContent:
+      file_name: 'pom.xml'
+      file_content_pattern: '<magnoliaVersion>'
 
 Sinatra:
   rules:
-    - !ruby/object:FileContentRule { file_name: 'config.ru', file_content_pattern: 'run Sinatra::Application' }
-    - !ruby/object:GemRule {}
+    - FileContent:
+      file_name: 'config.ru'
+      file_content_pattern: 'run Sinatra::Application'
+    - Gem
 
 Dashing:
   rules:
-    - !ruby/object:GemRule {}
+    - Gem
   primary: Sinatra
 
 Middleman:
   rules:
-    - !ruby/object:GemRule {}
+    - Gem
 
 Meteor:
   rules:
-    - !ruby/object:DirectoryPresenceRule { directory_name: '.meteor' }
+    - DirectoryPresence:
+      directory_name: '.meteor'
 
 Spree:
   rules:
-    - !ruby/object:GemRule {}
-    - !ruby/object:FileContentRule { file_name: 'boot.rb', file_content_pattern: 'Spree.boot!' }
+    - Gem
+    - FileContent:
+      file_name: 'boot.rb'
+      file_content_pattern: 'Spree.boot!'
   primary: Rails
 
 Wordpress:
   rules:
-    - !ruby/object:FilePresenceRule { file_name: 'wp-settings.php' }
+    - FilePresence:
+      file_name: 'wp-settings.php'
 
 Volt:
   rules:
-    - !ruby/object:GemRule {}
+    - Gem
 
 Ionic:
   rules:
-    - !ruby/object:FilePresenceRule { file_name: 'ionic.project' }
+    - FilePresence:
+      file_name: 'ionic.project'
 
 Node:
   rules:
-    - !ruby/object:FileContentRule
+    - FileContent:
       file_name: 'package.json'
-      file_content_pattern: '"engines":\s*{\s*"node":'
+      file_content_pattern: '^\s*"node":'
 
 Hoodie:
   rules:
-    - !ruby/object:FileContentRule
+    - FileContent:
       file_name: 'package.json'
       file_content_pattern: '"hoodie":\s*{'
   primary: Node
 
 PrestaShop:
   rules:
-    - !ruby/object:FileContentRule { file_name: 'init.php', file_content_pattern: 'PrestaShop' }
+    - FileContent:
+      file_name: 'init.php'
+      file_content_pattern: 'PrestaShop'
 
 Cordova:
   rules:
-    - !ruby/object:FileContentRule
+    - FileContent:
       file_name: 'config.xml'
       file_content_pattern: '\bxmlns:cdv="http://cordova.apache.org/ns/.+"'
 
 iOS:
   rules:
-    - !ruby/object:FileContentRule
+    - FileContent:
       file_name: 'project.pbxproj'
       file_content_pattern: '\n\s*SDKROOT = iphoneos;\n'
 
 Refinery CMS:
   rules:
-    - !ruby/object:GemRule { gem_name: 'refinerycms' }
+    - Gem:
+      gem_name: 'refinerycms'
   primary: Rails
 
 Rack:
   rules:
-    - !ruby/object:GemRule { gem_name: 'rack' }
-    - !ruby/object:FileContentRule
-      file_name: config.ru
+    - Gem:
+      gem_name: 'rack'
+    - FileContent:
+      file_name: 'config.ru'
       file_content_pattern: 'run Proc\.new { \|env\|'
+
+Magento:
+  rules:
+    - FileContent:
+      file_name: 'composer.json'
+      file_content_pattern: '^\s*"magento":\s*{\s*$'
+
+Vaadin:
+  rules:
+    - FileContent:
+      file_name: 'pom.xml'
+      file_content_pattern: '<version>\${vaadin.base.version}</version>'
+
+Spring:
+  rules:
+    - MavenPlugin:
+      plugin_name: 'org.springframework'
+    - MavenPlugin:
+      plugin_name: '${spring.groupId}'
+
+Felix:
+  rules:
+    - MavenPlugin:
+      plugin_name: 'org.apache.felix'
+
+GWT:
+  rules:
+    - MavenPlugin:
+      plugin_name: 'com.google.gwt'
+
+Jersey:
+  rules:
+    - MavenPlugin:
+      plugin_name: 'com.sun.jersey'

data/lib/technologist/git_repository.rb

@@ -12,17 +12,6 @@ module Technologist
       repository.head.target.tree
     end
 
-    # Returns the file content.
-    #
-    # @param file_name [String] the file name
-    #
-    # @return [String] The content of the file or nil if the file cannot be found.
-    def file_content(file_name)
-      file = find_blob(file_name)
-
-      file.content if file
-    end
-
     # 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.
@@ -31,18 +20,26 @@ module Technologist
     # @param current_tree [Rugged::Tree] the git directory tree in which to look for the blob.
     #   Defaults to the root tree (see `#root_tree`).
     #
+    # @yield [Rugged::Blob] Yields the found blob to an optional block.
+    #   If the block returns `true` it means that the file is found and
+    #   recursion is stopped. If the return value is `false`, the resursion continues.
+    #
     # @return [Rugged::Blob] The blob blob or nil if it cannot be found.
-    def find_blob(blob_name, current_tree = root_tree)
+    def find_blob(blob_name, current_tree = root_tree, &block)
       blob = current_tree[blob_name]
 
       if blob
-        repository.lookup(blob[:oid])
-      else
-        current_tree.each_tree do |sub_tree|
-          blob = find_blob(blob_name, repository.lookup(sub_tree[:oid]))
-          break blob if blob
+        blob = repository.lookup(blob[:oid])
+        if !block_given? || yield(blob)
+          return blob
         end
       end
+
+      # recurse
+      current_tree.each_tree do |sub_tree|
+        blob = find_blob(blob_name, repository.lookup(sub_tree[:oid]), &block)
+        break blob if blob
+      end
     end
 
     # Looks for a directory and returns true when the directory
@@ -64,5 +61,20 @@ module Technologist
     def file_exists?(file_name)
       !!find_blob(file_name)
     end
+
+    # Looks for a file and yields the file content to
+    # the block (if the file can be found). The block's
+    # return value is used to determine if we're done
+    # searching. If the return value is `false`, we
+    # keep searching for the file.
+    #
+    # @param file_name [String] the file name
+    #
+    # @return [Boolean] true if the file can be found.
+    def file_with_content_exists?(file_name)
+      !!find_blob(file_name) do |file|
+        yield file.content
+      end
+    end
   end
 end

data/lib/technologist/rules/directory_presence_rule.rb

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

data/lib/technologist/rules/file_content_rule.rb

@@ -3,7 +3,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}/)
+  def matches?(repository)
+    !!repository.file_with_content_exists?(file_name) do |content|
+      content =~ /#{file_content_pattern}/
+    end
   end
 end

data/lib/technologist/rules/file_presence_rule.rb

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

data/lib/technologist/rules/file_xml_content_rule.rb

@@ -0,0 +1,13 @@
+require 'technologist/rules/rule'
+require 'nokogiri'
+
+class FileXmlContentRule < Rule
+  attr_accessor :file_name, :css_selector
+
+  def matches?(repository)
+    !!repository.file_with_content_exists?(file_name) do |content|
+      xml = Nokogiri::XML(content)
+      xml.css(css_selector).any?
+    end
+  end
+end

data/lib/technologist/rules/gem_rule.rb

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

data/lib/technologist/rules/maven_plugin_rule.rb

@@ -0,0 +1,12 @@
+require 'technologist/rules/file_xml_content_rule'
+
+class MavenPluginRule < FileXmlContentRule
+  attr_accessor :plugin_name
+
+  def initialize(framework, attributes = {})
+    super
+
+    self.file_name = 'pom.xml'
+    self.css_selector = "dependencies > dependency > groupId[text() = '#{plugin_name}']"
+  end
+end

data/lib/technologist/rules/rule.rb

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

data/lib/technologist/version.rb

@@ -1,3 +1,3 @@
 module Technologist
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/technologist/yaml_parser.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+
+module Technologist
+  class YamlParser
+    attr_reader :file_name
+
+    def initialize(file_name)
+      @file_name = file_name
+    end
+
+    def rules
+      @rules ||=
+        begin
+          parsed_rules = from_file.map do |technology, definition|
+            definition['rules'].map! do |rule|
+              instancify(technology, rule)
+            end
+
+            [technology, definition]
+          end
+
+          Hash[parsed_rules]
+        end
+    end
+
+    private
+
+    def from_file
+      YAML.load_file(file_name)
+    end
+
+    # Create a class instance for a rule entry
+    def instancify(technology, rule)
+      class_name, attributes = send("parse_rule_of_type_#{rule.class.name.downcase}", rule)
+
+      Rule.const_get("#{class_name}Rule").new(technology, attributes)
+    end
+
+    # Parses a yaml rule where the rule entry is a string,
+    # meaning that only the rule class name is given.
+    # Sample yaml structure:
+    #   ```
+    #     Rails:
+    #       rules:
+    #         - Gem
+    #   ```
+    def parse_rule_of_type_hash(rule)
+      class_name = rule.keys.first
+      rule.delete(class_name)
+      attributes = rule
+
+      [class_name, attributes]
+    end
+
+    # Parses a yaml rule where the rule entry is a hash,
+    # meaning that the rule class also has attributes to be assigned.
+    # Sample yaml structure:
+    #   ```
+    #     Rails:
+    #       rules:
+    #         - Gem:
+    #           gem_name: 'jrails'
+    #   ```
+    def parse_rule_of_type_string(rule)
+      class_name = rule
+      attributes = {}
+
+      [class_name, attributes]
+    end
+  end
+end

data/technologist.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rugged", "~> 0.23.3"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: technologist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexis Reigel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.23.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,9 +122,12 @@ files:
 - lib/technologist/rules/directory_presence_rule.rb
 - lib/technologist/rules/file_content_rule.rb
 - lib/technologist/rules/file_presence_rule.rb
+- lib/technologist/rules/file_xml_content_rule.rb
 - lib/technologist/rules/gem_rule.rb
+- lib/technologist/rules/maven_plugin_rule.rb
 - lib/technologist/rules/rule.rb
 - lib/technologist/version.rb
+- lib/technologist/yaml_parser.rb
 - technologist.gemspec
 homepage: https://github.com/koffeinfrei/technologist
 licenses: