framework_identificator 1.4.1 → 2.0.0

data/README.md

@@ -1,6 +1,6 @@
 # FrameworkIdentificator [![Build Status](https://secure.travis-ci.org/zedtux/framework_identificator.png)](http://travis-ci.org/zedtux/framework_identificator) [![Dependency Status](https://gemnasium.com/zedtux/framework_identificator.png)](http://gemnasium.com/zedtux/framework_identificator) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/zedtux/framework_identificator) [![endorse](http://api.coderwall.com/zedtux/endorsecount.png)](http://coderwall.com/zedtux)
 
-Identify the used framework in a given project.
+Identify the used application or testing frameworks in a given project.
 
 ## Installation
 
@@ -18,17 +18,22 @@ Or install it yourself as:
 
 ## Usage
 
-### With a Pathname object
+### With a String object (project doesn't have tests (Berk))
+
+    FrameworkIdentificator.from(File.join("projects", "my_project"))
+    => {:application=>#<FrameworkIdentificator::Frameworks::Rails:0x007fddec3c1028 @source="/Users/zedtux/projects/my_project", @project_name="MyProject">, :testing=>[]}
+
+### With a Pathname object (project use Rspec for unit test)
 
     require "pathname"
     FrameworkIdentificator.from(Pathname.new(File.join("projects", "my_project")))
-    => #<FrameworkIdentificator::Frameworks::Rails:0x007fddec3c1028 @source="/Users/zedtux/projects/my_project", @project_name="MyProject">
+    => {:application=>#<FrameworkIdentificator::Frameworks::Rails:0x007fddec3c1028 @source="/Users/zedtux/projects/my_project", @project_name="MyProject">, :testing=>[#<FrameworkIdentificator::TestingFrameworks::Rspec:0x007fd7ec3be3b0>]}
 
-### With a Git object
+### With a Git object (project use Rspec and Cucumber frameworks)
 
     require "git"
     FrameworkIdentificator.from(Git.clone("git@myhost.tld:my_project", "my_project"))
-    => #<FrameworkIdentificator::Frameworks::Rails:0x007fddec3aff30 @source="/Users/zedtux/projects/my_project", @project_name="MyProject">
+    => {:application=>#<FrameworkIdentificator::Frameworks::Rails:0x007fddec3aff30 @source="/Users/zedtux/projects/my_project", @project_name="MyProject">, :testing=>[#<FrameworkIdentificator::TestingFrameworks::Cucumber:0x007fd7ec3be680>, #<FrameworkIdentificator::TestingFrameworks::Rspec:0x007fd7ec3be3b0>]}
 
 ## Implemented
 
@@ -38,7 +43,9 @@ Or install it yourself as:
 
 ### Frameworks
 
- - Rails
+|       | RSpec | Cucumber |
+| ----- | ----- | -------- |
+| Rails | √     | √        |
 
 ## Contributing
 
@@ -55,6 +62,6 @@ You can contribute to this gem by adding support for new [VCS](http://en.wikiped
 ### New framework
 
 This gem is built in order to allow easy contributions.
-To add a new framework, just add the new class in the `lib/framework_identificator/frameworks/` that implement the method `self.recognized?(source)`.
+To add a new framework, just add the new class in the `lib/framework_identificator/application_frameworks/` that implement the method `self.recognized?(source)`.
 
-Have a look at the [Rails framework class](/zedtux/framework_identificator/blob/master/lib/framework_identificator/frameworks/rails.rb).
+Have a look at the [Rails framework class](/zedtux/framework_identificator/blob/master/lib/framework_identificator/application_frameworks/rails.rb).

data/lib/framework_identificator.rb

@@ -9,21 +9,25 @@ require "framework_identificator/testing_frameworks"
 end
 
 module FrameworkIdentificator
-  def self.from(source, type)
+  def self.from(source)
     raise ArgumentError unless ["String", "Pathname", "Git::Base"].include?(source.class.name)
 
     # Use source itself if Pathname otherwise fetch the Git dir path
     source = source.class.name == "Git::Base" ? source.dir.path : source
     raise ArgumentError if source == ""
 
-    # Try to detect a Framework using the source
-    case type
-    when :application
-      FrameworkIdentificator::ApplicationFrameworks
-    when :testing
-      FrameworkIdentificator::TestingFrameworks
-    end.available.detect do |framework|
-      return framework.new(source) if framework.recognized?(source)
+    frameworks = {application: nil, testing: []}
+
+    # Try to detect an application framework using the source
+    FrameworkIdentificator::ApplicationFrameworks.available.detect do |framework|
+      frameworks[:application] = framework.new(source) if framework.recognized?(source)
+    end
+
+    # Try to detect a testing framework using the source
+    FrameworkIdentificator::TestingFrameworks.available.each do |framework|
+      frameworks[:testing] << framework.new(source) if framework.recognized?(source)
     end
+
+    frameworks
   end
 end

data/lib/framework_identificator/testing_frameworks/cucumber.rb

@@ -0,0 +1,27 @@
+module FrameworkIdentificator
+  module TestingFrameworks
+    class Cucumber
+      # ~~~~ Attributes ~~~~
+      attr_accessor :source
+
+      # ~~~~ Class Methods ~~~~
+      def self.recognized?(source)
+        @source = source
+
+        self.has_features_env_file?
+      end
+
+      # ~~~~ Instance Methods ~~~~
+      def initialize(*source)
+        # Nothing do initialize for now
+      end
+
+      private
+
+      def self.has_features_env_file?
+        File.exists?(File.join(@source, "features", "support", "env.rb"))
+      end
+
+    end
+  end
+end

data/lib/framework_identificator/version.rb

@@ -1,3 +1,3 @@
 module FrameworkIdentificator
-  VERSION = "1.4.1"
+  VERSION = "2.0.0"
 end

data/spec/framework_identificator/application_frameworks/rails_spec.rb

@@ -31,13 +31,13 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
                 before do
                   FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true)
                   FrameworkIdentificator::ApplicationFrameworks::Rails.any_instance.stub(:parse_source).and_return(true)
-                  @framework = FrameworkIdentificator.from(@repository_path, :application)
+                  @framework = FrameworkIdentificator.from(@repository_path)
                 end
                 it "should return not return a nil" do
                   @framework.should_not be_nil
                 end
-                it "should return an instance of ApplicationFrameworks::Rails" do
-                  @framework.class.should be FrameworkIdentificator::ApplicationFrameworks::Rails
+                it "should return an instance of FrameworkIdentificator::ApplicationFrameworks::Rails" do
+                  @framework[:application].class.should be FrameworkIdentificator::ApplicationFrameworks::Rails
                 end
                 describe "instance" do
                   describe "project_name" do
@@ -55,8 +55,8 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -64,14 +64,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -82,14 +82,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -97,14 +97,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -118,14 +118,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -133,14 +133,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -151,14 +151,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end
@@ -166,14 +166,14 @@ describe FrameworkIdentificator::ApplicationFrameworks::Rails do
               before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
               context "with a Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(true) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
               context "without Rakefile" do
                 before { FrameworkIdentificator::ApplicationFrameworks::Rails.stub(:have_rakefile?).and_return(false) }
-                it "should return false" do
-                  FrameworkIdentificator.from(@repository_path, :application).should be_false
+                it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+                  FrameworkIdentificator.from(@repository_path).should == {application: nil, testing: []}
                 end
               end
             end

data/spec/framework_identificator/testing_frameworks/cucumber_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe FrameworkIdentificator::TestingFrameworks::Cucumber do
+
+  describe "Attributes" do
+    it "should have an attribute :source" do
+      subject.should respond_to(:source)
+      subject.should respond_to(:source=)
+    end
+  end
+
+  describe "Class Methods" do
+    describe "TestingFrameworks" do
+      before { @repository_path = Pathname.new(File.join("projects", "my_rails_project")) }
+      describe "for Cucumber framework" do
+        context "without features/support/env.rb file" do
+          before do
+            FrameworkIdentificator::TestingFrameworks::Cucumber.stub(:has_features_env_file?).and_return(false)
+            @framework = FrameworkIdentificator.from(@repository_path)
+          end
+          it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+            @framework.should == {application: nil, testing: []}
+          end
+        end
+        context "with features/support/env.rb file" do
+          before do
+            FrameworkIdentificator::TestingFrameworks::Cucumber.stub(:has_features_env_file?).and_return(true)
+            @framework = FrameworkIdentificator.from(@repository_path)
+          end
+          it "should return not return a nil" do
+            @framework.should_not be_nil
+          end
+          it "should return a Hash with :testing key having an array of a size of 1" do
+            @framework[:testing].size.should == 1
+          end
+          it "should return a Hash with :testing key having an element FrameworkIdentificator::TestingFrameworks::Cucumber" do
+            @framework[:testing].first.class.should be FrameworkIdentificator::TestingFrameworks::Cucumber
+          end
+        end
+      end
+    end
+  end
+end

data/spec/framework_identificator/testing_frameworks/rspec_spec.rb

@@ -16,22 +16,25 @@ describe FrameworkIdentificator::TestingFrameworks::Rspec do
         context "without spec/spec_helper.rb file" do
           before do
             FrameworkIdentificator::TestingFrameworks::Rspec.stub(:has_spec_spec_helper_file?).and_return(false)
-            @framework = FrameworkIdentificator.from(@repository_path, :testing)
+            @framework = FrameworkIdentificator.from(@repository_path)
           end
-          it "should return return a nil" do
-            @framework.should be_nil
+          it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+            @framework.should == {application: nil, testing: []}
           end
         end
         context "with spec/spec_helper.rb file" do
           before do
             FrameworkIdentificator::TestingFrameworks::Rspec.stub(:has_spec_spec_helper_file?).and_return(true)
-            @framework = FrameworkIdentificator.from(@repository_path, :testing)
+            @framework = FrameworkIdentificator.from(@repository_path)
           end
           it "should return not return a nil" do
             @framework.should_not be_nil
           end
-          it "should return an instance of ApplicationFrameworks::Rspec" do
-            @framework.class.should be FrameworkIdentificator::TestingFrameworks::Rspec
+          it "should return a Hash with :testing key having an array of a size of 1" do
+            @framework[:testing].size.should == 1
+          end
+          it "should return a Hash with :testing key having an element FrameworkIdentificator::TestingFrameworks::Rspec" do
+            @framework[:testing].first.class.should be FrameworkIdentificator::TestingFrameworks::Rspec
           end
         end
       end

data/spec/framework_identificator/testing_frameworks_spec.rb

@@ -3,8 +3,11 @@ require "spec_helper"
 describe FrameworkIdentificator::TestingFrameworks do
 
   describe "#available" do
-    it "should return an array with FrameworkIdentificator::ApplicationFrameworks::Rspec" do
-      subject.available.should == [FrameworkIdentificator::TestingFrameworks::Rspec]
+    it "should return an array of all classes included into the TestingFrameworks module" do
+      subject.available.should == [
+        FrameworkIdentificator::TestingFrameworks::Cucumber,
+        FrameworkIdentificator::TestingFrameworks::Rspec
+      ]
     end
   end
 

data/spec/framework_identificator_spec.rb

@@ -13,7 +13,7 @@ describe FrameworkIdentificator do
     context "with an empty string" do
       it "should raise an ArgumentError" do
         lambda {
-          subject.from("", :application)
+          subject.from("")
         }.should raise_error(ArgumentError)
       end
     end
@@ -21,19 +21,19 @@ describe FrameworkIdentificator do
       before { @source_string = File.join("projects", "my_rails_project") }
       it "should not raise anything" do
         lambda {
-          subject.from(@source_string, :application)
+          subject.from(@source_string)
         }.should_not raise_error
       end
       it "should return false" do
-        subject.from(@source_string, :application).should be_false
+        subject.from(@source_string).should == {application: nil, testing: []}
       end
     end
     describe "with a Pathname object" do
       before { @repository_path = Pathname.new(File.join("projects", "my_rails_project")) }
       describe "for a basic folders/files project" do
         before { @basic_folders_and_files_path = Pathname.new(File.join("spec", "fixtures", "basic_folders_and_files")) }
-        it "should return false" do
-          subject.from(@basic_folders_and_files_path, :application).should be_false
+        it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+          subject.from(@basic_folders_and_files_path).should == {application: nil, testing: []}
         end
       end
     end
@@ -45,8 +45,8 @@ describe FrameworkIdentificator do
       end
       describe "for a basic folders/files project" do
         before { @basic_folders_and_files_path = Pathname.new(File.join("spec", "fixtures", "basic_folders_and_files")) }
-        it "should return false" do
-          subject.from(@basic_folders_and_files_path, :application).should be_false
+        it "should return a Hash with a :application key with a nil value and a :testing key with an empty Array as value" do
+          subject.from(@basic_folders_and_files_path).should == {application: nil, testing: []}
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framework_identificator
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-24 00:00:00.000000000 Z
+date: 2012-12-28 00:00:00.000000000 Z
 dependencies: []
 description: Identify the used framework of a given project.
 email:
@@ -33,12 +33,14 @@ files:
 - lib/framework_identificator/application_frameworks/rails.rb
 - lib/framework_identificator/framework.rb
 - lib/framework_identificator/testing_frameworks.rb
+- lib/framework_identificator/testing_frameworks/cucumber.rb
 - lib/framework_identificator/testing_frameworks/rspec.rb
 - lib/framework_identificator/version.rb
 - spec/fixtures/basic_folders_and_files/backup/main.sh
 - spec/fixtures/basic_folders_and_files/main.sh
 - spec/framework_identificator/application_frameworks/rails_spec.rb
 - spec/framework_identificator/application_frameworks_spec.rb
+- spec/framework_identificator/testing_frameworks/cucumber_spec.rb
 - spec/framework_identificator/testing_frameworks/rspec_spec.rb
 - spec/framework_identificator/testing_frameworks_spec.rb
 - spec/framework_identificator_spec.rb
@@ -57,7 +59,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2322913756995590960
+      hash: 1365417599632752041
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -66,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2322913756995590960
+      hash: 1365417599632752041
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -79,6 +81,7 @@ test_files:
 - spec/fixtures/basic_folders_and_files/main.sh
 - spec/framework_identificator/application_frameworks/rails_spec.rb
 - spec/framework_identificator/application_frameworks_spec.rb
+- spec/framework_identificator/testing_frameworks/cucumber_spec.rb
 - spec/framework_identificator/testing_frameworks/rspec_spec.rb
 - spec/framework_identificator/testing_frameworks_spec.rb
 - spec/framework_identificator_spec.rb