framework_identificator 1.1.0 → 1.2.0

data/README.md

@@ -43,8 +43,17 @@ Or install it yourself as:
 
 You can contribute to this gem by adding support for new [VCS](http://en.wikipedia.org/wiki/Concurrent_Versions_System) or new frameworks.
 
+### Fork
+
 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
+
+### 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)`.
+
+Have a look at the [Rails framework class](/zedtux/framework_identificator/blob/master/lib/framework_identificator/frameworks/rails.rb).

data/lib/framework_identificator/frameworks/rails.rb

@@ -1,43 +1,73 @@
 module Frameworks
   class Rails
-    attr_accessor :source
+    # ~~~~ Attributes ~~~~
+    attr_accessor :source, :routes_path, :project_name
+
+    # ~~~~ Class Methods ~~~~
     def self.recognized?(source)
       @source = source
 
       self.recognize_a_rails_project?
     end
 
+    # ~~~~ Instance Methods ~~~~
+    def initialize(*source)
+      if self.source = source.first
+        self.parse_source
+      end
+    end
+
+  protected
+
+    def parse_source
+      self.project_name = File.open(self.class.send(:routes_rb_path)) do |file|
+        file.readline.scan(/^([A-z]+).*do$/).flatten.first
+      end
+    end
+
   private
 
     def self.recognize_a_rails_project?
-      self.have_valid_script_folder? &&
+      (self.have_valid_rails_2_script_folder? ||
+       self.have_valid_rails_3_script_folder?) &&
       self.have_valid_app_folder? &&
       self.have_valid_config_folder? &&
       self.have_rakefile?
     end
 
-    def self.have_valid_script_folder?
+    def self.have_valid_rails_2_script_folder?
+      File.exists?(File.join(@source, "script", "console")) &&
+      File.exists?(File.join(@source, "script", "dbconsole")) &&
+      File.exists?(File.join(@source, "script", "generate")) &&
+      File.exists?(File.join(@source, "script", "plugin")) &&
+      File.exists?(File.join(@source, "script", "runner")) &&
+      File.exists?(File.join(@source, "script", "server"))
+    end
+
+    def self.have_valid_rails_3_script_folder?
       File.exists?(File.join(@source, "script", "rails"))
     end
 
     def self.have_valid_app_folder?
-      File.exists?(File.join(@source, "app", "controllers"))
-      File.exists?(File.join(@source, "app", "models"))
+      File.exists?(File.join(@source, "app", "controllers")) &&
+      File.exists?(File.join(@source, "app", "models")) &&
       File.exists?(File.join(@source, "app", "views"))
     end
 
     def self.have_valid_config_folder?
-      File.exists?(File.join(@source, "config", "environments"))
-      File.exists?(File.join(@source, "config", "environments", "development.rb"))
-      File.exists?(File.join(@source, "config", "application.rb"))
-      File.exists?(File.join(@source, "config", "boot.rb"))
-      File.exists?(File.join(@source, "config", "environment.rb"))
-      File.exists?(File.join(@source, "config", "routes.rb"))
+      File.exists?(File.join(@source, "config", "environments")) &&
+      File.exists?(File.join(@source, "config", "environments", "development.rb")) &&
+      File.exists?(File.join(@source, "config", "boot.rb")) &&
+      File.exists?(File.join(@source, "config", "environment.rb")) &&
+      File.exists?(self.send(:routes_rb_path))
     end
 
     def self.have_rakefile?
       File.exists?(File.join(@source, "Rakefile"))
     end
 
+    def self.routes_rb_path
+      File.join(@source, "config", "routes.rb")
+    end
   end
 end

data/lib/framework_identificator/version.rb

@@ -1,3 +1,3 @@
 module FrameworkIdentificator
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/framework_identificator.rb

@@ -12,6 +12,8 @@ module FrameworkIdentificator
     source = source.is_a?(Git::Base) ? source.dir.path : source
 
     # Try to detect a Framework using the source
-    Frameworks.available.detect{|framework| framework.recognized?(source)}
+    Frameworks.available.detect do |framework|
+      return framework.new(source) if framework.recognized?(source)
+    end
   end
 end

data/spec/framework_identificator/frameworks/rails_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Frameworks::Rails do
+
+  describe "Attributes" do
+    it "should have an attribute :source" do
+      subject.should respond_to(:source)
+      subject.should respond_to(:source=)
+    end
+    it "should have an attribute :routes_path" do
+      subject.should respond_to(:routes_path)
+      subject.should respond_to(:routes_path=)
+    end
+    it "should have an attribute :project_name" do
+      subject.should respond_to(:project_name)
+      subject.should respond_to(:project_name=)
+    end
+  end
+
+  describe "Class Methods" do
+    
+  end
+end

data/spec/framework_identificator/frameworks_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Frameworks do
+
+  describe "#available" do
+    it "should return an array with Frameworks::Rails" do
+      subject.available.should == [Frameworks::Rails]
+    end
+  end
+
+end

data/spec/framework_identificator_spec.rb

@@ -3,14 +3,14 @@ require "spec_helper"
 describe FrameworkIdentificator do
 
   describe "#from" do
-    describe "with a nil" do
+    context "with a nil" do
       it "should raise an ArgumentError" do
         lambda {
           subject.from
         }.should raise_error(ArgumentError)
       end
     end
-    describe "with an empty string" do
+    context "with an empty string" do
       it "should raise an ArgumentError" do
         lambda {
           subject.from("")
@@ -20,39 +20,54 @@ describe FrameworkIdentificator do
     describe "with a Pathname object" do
       before { @repository_path = Pathname.new(File.join("projects", "my_rails_project")) }
       describe "for a Rails framework" do
-        describe "with script/rails" do
-          before { Frameworks::Rails.stub(:have_valid_script_folder?).and_return(true) }
-          describe "with valid app/ folder" do
+        context "with script/rails" do
+          before { Frameworks::Rails.stub(:have_valid_rails_3_script_folder?).and_return(true) }
+          context "with valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
-                before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
+              context "with a Rakefile" do
+                before do
+                  Frameworks::Rails.stub(:have_rakefile?).and_return(true)
+                  Frameworks::Rails.any_instance.stub(:parse_source).and_return(true)
+                  @framework = subject.from(@repository_path)
+                end
                 it "should return not return a nil" do
-                  framework = subject.from(@repository_path)
-                  framework.should_not be_nil
+                  @framework.should_not be_nil
                 end
                 it "should return an instance of Frameworks::Rails" do
-                  framework = subject.from(@repository_path)
-                  framework.should be Frameworks::Rails
-                end
-              end
-              describe "without Rakefile" do
+                  @framework.class.should be Frameworks::Rails
+                end
+                describe "instance" do
+                  describe "project_name" do
+                    before { @framework.stub(:project_name).and_return("MyRailsProject") }
+                    it "should respond to project_name" do
+                      @framework.should respond_to(:project_name)
+                    end
+                    context "with a project name \"MyRailsProject\"" do
+                      it "should return the \"MyRailsProject\"" do
+                        @framework.project_name.should == "MyRailsProject"
+                      end
+                    end
+                  end
+                end
+              end
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
@@ -60,32 +75,32 @@ describe FrameworkIdentificator do
               end
             end
           end
-          describe "without valid app/ folder" do
+          context "without valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
@@ -94,34 +109,34 @@ describe FrameworkIdentificator do
             end
           end
         end
-        describe "with script/rails" do
+        context "with script/rails" do
           before { Frameworks::Rails.stub(:have_valid_script_folder?).and_return(false) }
-          describe "with valid app/ folder" do
+          context "with valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
@@ -129,32 +144,32 @@ describe FrameworkIdentificator do
               end
             end
           end
-          describe "without valid app/ folder" do
+          context "without valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@repository_path).should be_false
@@ -178,39 +193,55 @@ describe FrameworkIdentificator do
         @git_repository.stub_chain(:dir, :path).and_return(File.join("projects", "my_rails_project"))
       end
       describe "for a Rails framework" do
-        describe "with script/rails" do
-          before { Frameworks::Rails.stub(:have_valid_script_folder?).and_return(true) }
-          describe "with valid app/ folder" do
+        context "with script/ folder" do
+          before { Frameworks::Rails.stub(:have_valid_rails_3_script_folder?).and_return(true) }
+          context "with valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
-                before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
+              context "with a Rakefile" do
+                before do
+                  Frameworks::Rails.stub(:have_rakefile?).and_return(true)
+                  Frameworks::Rails.any_instance.stub(:parse_source).and_return(true)
+                  @framework = subject.from(@git_repository)
+                end
                 it "should return not return a nil" do
-                  framework = subject.from(@git_repository)
-                  framework.should_not be_nil
+                  @framework.should_not be_nil
                 end
                 it "should return an instance of Frameworks::Rails" do
-                  framework = subject.from(@git_repository)
-                  framework.should be Frameworks::Rails
-                end
-              end
-              describe "without Rakefile" do
+                  @framework.class.should be Frameworks::Rails
+                end
+                describe "instance" do
+                  it "should respond to project_name" do
+                    @framework.should respond_to(:project_name)
+                    puts "Project name: \"#{@framework.project_name}\""
+                  end
+                  describe "project_name" do
+                    context "with a project name \"MyRailsProject\"" do
+                      before { @framework.stub(:project_name).and_return("MyRailsProject") }
+                      it "should return the \"MyRailsProject\"" do
+                        @framework.project_name.should == "MyRailsProject"
+                      end
+                    end
+                  end
+                end
+              end
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
@@ -218,32 +249,32 @@ describe FrameworkIdentificator do
               end
             end
           end
-          describe "without valid app/ folder" do
+          context "without valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
@@ -252,34 +283,34 @@ describe FrameworkIdentificator do
             end
           end
         end
-        describe "with script/rails" do
+        context "with script/rails" do
           before { Frameworks::Rails.stub(:have_valid_script_folder?).and_return(false) }
-          describe "with valid app/ folder" do
+          context "with valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
@@ -287,32 +318,32 @@ describe FrameworkIdentificator do
               end
             end
           end
-          describe "without valid app/ folder" do
+          context "without valid app/ folder" do
             before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
-            describe "with valid config/ folder" do
+            context "with valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(true) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
             end
-            describe "without valid config/ folder" do
+            context "without valid config/ folder" do
               before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
-              describe "with a Rakefile" do
+              context "with a Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(true) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false
                 end
               end
-              describe "without Rakefile" do
+              context "without Rakefile" do
                 before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
                 it "should return false" do
                   subject.from(@git_repository).should be_false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framework_identificator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -34,6 +34,8 @@ files:
 - 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/frameworks/rails_spec.rb
+- spec/framework_identificator/frameworks_spec.rb
 - spec/framework_identificator_spec.rb
 - spec/spec_helper.rb
 - spec/support/webmocks.rb
@@ -49,12 +51,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1867397364544472375
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1867397364544472375
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -65,6 +73,8 @@ summary: This gem will identify the framework of a given project based on existi
 test_files:
 - spec/fixtures/basic_folders_and_files/backup/main.sh
 - spec/fixtures/basic_folders_and_files/main.sh
+- spec/framework_identificator/frameworks/rails_spec.rb
+- spec/framework_identificator/frameworks_spec.rb
 - spec/framework_identificator_spec.rb
 - spec/spec_helper.rb
 - spec/support/webmocks.rb