framework_identificator 1.0.0

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+log/

data/.gpairrc

@@ -0,0 +1 @@
+alone for github

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3@framework_identificator

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - ruby-head
+  - 1.9.3
+  - 1.8.7
+  - 1.9.2
+  - ree

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in framework_identificator.gemspec
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "git"
+gem "simplecov"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 zedtux
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'framework_identificator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install framework_identificator
+
+## Usage
+
+### With a Pathname object
+
+    FrameworkIdentificator.from(Pathname.new(File.join("projects", "my_project")))
+    => Frameworks::Rails
+
+### With a Git object
+
+    require "git"
+    FrameworkIdentificator.from(Git.clone("git@myhost.tld:my_project", "my_project"))
+    => Frameworks::Rails
+
+## Implemented
+
+### VCS
+
+ - Git
+
+### Frameworks
+
+ - Rails
+
+## Contributing
+
+You can contribute to this gem by adding support for new [VCS](http://en.wikipedia.org/wiki/Concurrent_Versions_System) or new frameworks.
+
+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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new("spec")
+
+task :default => :spec

data/framework_identificator.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "framework_identificator/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "framework_identificator"
+  gem.version       = FrameworkIdentificator::VERSION
+  gem.authors       = ["zedtux"]
+  gem.email         = ["zedtux@zedroot.org"]
+  gem.description   = %q{Identify the used framework of a given project.}
+  gem.summary       = %q{This gem will identify the framework of a given project based on existing files and path.}
+  gem.homepage      = "https://github.com/zedtux/framework_identificator"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/framework_identificator/frameworks/rails.rb

@@ -0,0 +1,43 @@
+module Frameworks
+  class Rails
+    attr_accessor :source
+    def self.recognized?(source)
+      @source = source.is_a?(Git::Base) ? source.dir.path : source
+
+      self.recognize_a_rails_project? ? self.new : nil
+    end
+
+  private
+
+    def self.recognize_a_rails_project?
+      self.have_valid_script_folder? &&
+      self.have_valid_app_folder? &&
+      self.have_valid_config_folder? &&
+      self.have_rakefile?
+    end
+
+    def self.have_valid_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", "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"))
+    end
+
+    def self.have_rakefile?
+      File.exists?(File.join(@source, "Rakefile"))
+    end
+
+  end
+end

data/lib/framework_identificator/version.rb

@@ -0,0 +1,3 @@
+module FrameworkIdentificator
+  VERSION = "1.0.0"
+end

data/lib/framework_identificator.rb

@@ -0,0 +1,12 @@
+require "framework_identificator/version"
+require "framework_identificator/frameworks/rails"
+
+module FrameworkIdentificator
+  def self.from(source)
+    raise ArgumentError unless source.is_a?(Pathname) || source.is_a?(Git::Base)
+
+    [Frameworks::Rails].detect do |framework|
+      framework.recognized?(source)
+    end
+  end
+end

data/spec/fixtures/basic_folders_and_files/backup/main.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "Welcome"

data/spec/fixtures/basic_folders_and_files/main.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "Welcome to my script"

data/spec/framework_identificator_spec.rb

@@ -0,0 +1,334 @@
+require "spec_helper"
+
+describe FrameworkIdentificator do
+
+  describe "#from" do
+    describe "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
+      it "should raise an ArgumentError" do
+        lambda {
+          subject.from("")
+        }.should raise_error(ArgumentError)
+      end
+    end
+    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
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
+            describe "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) }
+                it "should return not return a nil" do
+                  framework = subject.from(@repository_path)
+                  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
+                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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+            end
+          end
+          describe "without valid app/ folder" do
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
+            describe "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) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+              describe "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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+            end
+          end
+        end
+        describe "with script/rails" do
+          before { Frameworks::Rails.stub(:have_valid_script_folder?).and_return(false) }
+          describe "with valid app/ folder" do
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
+            describe "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) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+              describe "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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+            end
+          end
+          describe "without valid app/ folder" do
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
+            describe "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) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+              describe "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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@repository_path).should be_false
+                end
+              end
+            end
+          end
+        end
+      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).should be_false
+        end
+      end
+    end
+    describe "with a Git object" do
+      before do
+        Git.stub!(:clone).and_return(Git::Base.new)
+        @git_repository = Git.clone("git://citask.it:citaskit", "Test.git")
+        @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
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
+            describe "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) }
+                it "should return not return a nil" do
+                  framework = subject.from(@git_repository)
+                  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
+                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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+            end
+          end
+          describe "without valid app/ folder" do
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
+            describe "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) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+              describe "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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+            end
+          end
+        end
+        describe "with script/rails" do
+          before { Frameworks::Rails.stub(:have_valid_script_folder?).and_return(false) }
+          describe "with valid app/ folder" do
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(true) }
+            describe "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) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+              describe "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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+            end
+          end
+          describe "without valid app/ folder" do
+            before { Frameworks::Rails.stub(:have_valid_app_folder?).and_return(false) }
+            describe "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) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+              describe "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
+              before { Frameworks::Rails.stub(:have_valid_config_folder?).and_return(false) }
+              describe "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
+                before { Frameworks::Rails.stub(:have_rakefile?).and_return(false) }
+                it "should return false" do
+                  subject.from(@git_repository).should be_false
+                end
+              end
+            end
+          end
+        end
+      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).should be_false
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+if RUBY_VERSION[0, 3] == "1.9"
+  require "simplecov"
+  SimpleCov.start
+end
+
+require "rubygems"
+require "bundler/setup"
+
+# our gem
+require "framework_identificator"
+require "git"
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: framework_identificator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- zedtux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-20 00:00:00.000000000 Z
+dependencies: []
+description: Identify the used framework of a given project.
+email:
+- zedtux@zedroot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gpairrc
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- framework_identificator.gemspec
+- lib/framework_identificator.rb
+- lib/framework_identificator/frameworks/rails.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_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmocks.rb
+homepage: https://github.com/zedtux/framework_identificator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4491665536790450036
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4491665536790450036
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem will identify the framework of a given project based on existing
+  files and path.
+test_files:
+- spec/fixtures/basic_folders_and_files/backup/main.sh
+- spec/fixtures/basic_folders_and_files/main.sh
+- spec/framework_identificator_spec.rb
+- spec/spec_helper.rb
+- spec/support/webmocks.rb