laravel 0.0.1 → 0.0.2

data/.gitignore

@@ -16,3 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
+repositories/*
+!.gitkeep
+__tests

data/.travis.yml

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -1,8 +1,14 @@
 # Laravel
 
 A wrapper around Laravel framework for PHP.  
+Currently, is only capable of downloading Laravel source from
+a local directory, some git based (online/offline) repository
+or from the official source on Github.  
 Still in development.
 
+[![Code
+Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/nikhgupta/laravel)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,7 +25,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create a new Laravel application
+
+Laravel gem has a caching mechanism in-built, which allows to keep a local
+copy when you use the remote repositories for the first time. After this,
+whenever you use the remote repository again, it will only update the local
+repository (as opposed to a fresh git clone, which is considerably slow for
+certain connections). This will, further, allow you to install Laravel
+applications even when you are not connected to the Internet.
+
+Since, you can specify which git repository to use to fetch the Laravel
+source, you can create new Laravel application based on your own or someone
+else's fork of Laravel, if required. And, yes! These repositories will be
+cached!
+
+    # with default settings (fetches source from http://github.com/laravel/laravel.git)
+    laravel new my_app
+    
+    # force a clean install on existing directory
+    laravel new my_app --force
+    
+    # using an existing (already downloaded) source
+    laravel new my_app --local=/usr/src/laravel
+
+    # using a remote repository
+    laravel new my_app --remote="http://github.com/user/my_laravel_fork"
+    
+### Help
+
+    laravel help
+
+## Coming Soon..
+    # create and customize a new Laravel application
+    laravel new my_app --index=''           # set application index to blank
+    laravel new my_app --[no-]key           # generate a new key
+    laravel new my_app --database=db_my_app # create a database, defaults to app name
+    laravel new my_app --[no-]generator     # download the Laravel Generator by Jeffrey Way
+    laravel new my_app --bundles=sentry,bob # install the provided bundles
 
 ## Contributing
 

data/Rakefile

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

data/bin/laravel

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require "laravel"
+require "thor"
+
+module Laravel
+  class CLI < Thor
+
+    # display version/information about this gem
+    desc "info", "displays usage information about this gem."
+    method_options %w( version -v) => :boolean
+    def info
+      if options[:version]
+        puts "Laravel v#{Laravel::VERSION}"
+      else
+        puts Laravel::INFO
+      end
+      # puts "Made possible by efforts of Laravel Community"
+    end
+
+    # create a new laravel application
+    desc "new [MY_APP]", "install a new Laravel application"
+    method_option :local,  :type => :string, :aliases => "-l", :banner => "DIRECTORY",
+      :desc => "use laravel source from a local directory"
+    method_option :remote, :type => :string,  :aliases => "-r", :banner => "GIT_REPO",
+      :desc => "use this git repository instead (useful when working with forks, e.g.)"
+    method_option :force,  :type => :boolean, :aliases => "-f",
+      :desc => "force overwrite"
+    def new(app_name)
+      result = Laravel::Download::source app_name, options
+      if result
+        say_status "ERROR!!", result, :red
+      else
+        say_status "Success", "Application Downloaded Successfully!"
+      end
+    end
+
+    # choose a default task to run
+    default_task :info
+
+  end
+end
+
+Laravel::CLI.start

data/laravel.gemspec

@@ -17,5 +17,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  # gem.add_development_dependency 'rspec'
+  gem.add_dependency 'thor'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'rb-fsevent'
 end

data/lib/laravel/download.rb

@@ -0,0 +1,81 @@
+module Laravel
+  class Download
+    # This method downloads the Laravel source files.
+    #
+    # When downloading from remote repositories, it checks to see if we have
+    # previously used that repository (can be the official Laravel source or
+    # forked one). If so, it updates the local copy of that repository and 
+    # installs from it. Otherwise, it creates a local copy of the repository
+    # so that future installs from that repository are instant.
+    #
+    # * *Args*    :
+    #   - +path+ -> path to the destination
+    # * *Returns* :
+    #   - string containing error message, if any or is otherwise nil
+    #
+    def self.source(path, options)
+
+      # make sure that the path does not already exists (no overwrites!)
+      if File.exists?(path) and not options[:force]
+        return "directory already exists!"
+      end
+
+      # delete the existing files, if we are forced for this
+      FileUtils.rm_rf path if options[:force]
+
+      # create the requisite directory structure
+      FileUtils.mkdir_p File.dirname(path)
+
+      # download/update local repository as required
+      local_repo_for_remote_path = options[:local] || Laravel::Download::local_repository(options)
+
+      # copy the Laravel source to the required path
+      FileUtils.cp_r local_repo_for_remote_path, path
+
+      # remove the downloaded source if it is not a valid laravel source
+      unless Laravel::has_laravel? path
+        FileUtils.rm_rf "#{path}"
+        FileUtils.rm_rf "#{local_repo_for_remote_path}"
+        return "laravel source is corrupted!"
+      end
+
+    end
+
+    # Create or update local repository whenever a remote source is specified.
+    #
+    # * *Args*    :
+    #   - +options+ -> arguments passed from other tasks, if any.
+    # * *Returns* :
+    #   - boolean depending on whether a download/update was done or not
+    #
+    def self.local_repository(options = {})
+      # do not attempt download/update if user specifically wants to stay offline
+      return if options.has_key?(:local)
+
+      # prefer remote path, if specifically supplied by user
+      # otherwise, default to the official repository
+      remote_repo = options[:remote] || Laravel::OfficialRepository
+      local_path_for_remote_repo = Laravel::crypted_path remote_repo
+
+      # get the path to the git binary
+      git = `which git`.strip
+
+      # string which will suppress the output of commands in quiet mode
+      quiet = options[:quiet] ? "&>/dev/null" : "1>/dev/null"
+
+      # update or download the remote repository
+      FileUtils.mkdir_p local_path_for_remote_repo
+      Dir.chdir local_path_for_remote_repo do
+        if Laravel::local_repository_exists?(remote_repo)
+          puts "Updating repository in local cache.." unless options[:quiet]
+          puts `#{git} pull #{quiet}`
+        else
+          puts "Downloading repository to local cache.." unless options[:quiet]
+          puts `#{git} clone #{remote_repo} . #{quiet}`
+        end
+      end
+
+      local_path_for_remote_repo
+    end
+  end
+end

data/lib/laravel/helpers.rb

@@ -0,0 +1,36 @@
+require 'digest/md5'
+
+module Laravel
+  LocalRepositories = File.expand_path(File.join(File.dirname(__FILE__), %w[ .. .. repositories ]))
+  OfficialRepository = "http://github.com/laravel/laravel.git"
+
+  # check if the given folder is a laravel source
+  # we check this by looking for presence of 'artisan', 'laravel/', etc.
+  def self.has_laravel?(directory)
+    return false unless File.exists?    File.join( directory, "artisan" )
+    return false unless File.directory? File.join( directory, "laravel" )
+    true
+  end
+
+  # check if this is the first installation from this gem
+
+  # check if local repository exists for a given remote git source
+  def self.local_repository_exists?(source)
+    local_repository_path = Laravel::crypted_path(source)
+    if Laravel::has_laravel? local_repository_path
+      local_repository_path
+    else
+      nil
+    end
+  end
+
+  # return the crypted folder name for a given remote repository
+  def self.crypted_name(source)
+    (Digest::MD5.new << source).to_s
+  end
+
+  # return the crypted folder path for a given remote repository
+  def self.crypted_path(source)
+    File.join(Laravel::LocalRepositories, Laravel::crypted_name(source))
+  end
+end

data/lib/laravel/info.rb

@@ -0,0 +1,18 @@
+module Laravel
+  INFO = '''
+  Create a new Laravel application
+
+    # with default settings
+    # fetches source from http://github.com/laravel/laravel.git
+    laravel new my_app
+
+    # force a clean install on existing directory
+    laravel new my_app --force
+
+    # using an existing (already downloaded) source
+    laravel new my_app --local=/usr/src/laravel
+
+    # using a remote repository
+    laravel new my_app --remote="http://github.com/user/my_laravel_fork"
+  '''
+end

data/lib/laravel/version.rb

@@ -1,3 +1,3 @@
 module Laravel
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/laravel.rb

@@ -1,7 +1,4 @@
 require "laravel/version"
-
-module Laravel
-  class Hello
-    puts "Hello World!\n I am still prepping up myself.. Stay tuned!"
-  end
-end
+require "laravel/info"
+require "laravel/helpers"
+require "laravel/download"

data/spec/laravel/download/download_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Laravel::Download do
+
+  before(:each) { Laravel::Tests::cleanup }
+  after(:each)  { Laravel::Tests::cleanup }
+
+  it "should download source from a manually specified laravel repository" do
+    # preparations
+    options = { :remote => "https://github.com/laravel/pastes.git" }
+    Laravel::Tests::cleanup options[:remote]
+
+    # actions
+    print "  downloading git repository.. this may take a while.."
+    app_path = Laravel::Tests::app_downloads_nicely? options
+
+    # expectations
+    app_path.should_not be_nil
+    Laravel::local_repository_exists?(options[:remote])
+    Laravel::Tests::download_was_performed?(app_path)
+  end
+
+  it "should not download source from a non-laravel app" do
+    # preparations
+    options = { :remote => "http://github.com/nikhgupta/snipmate-snippets.git" }
+
+    # actions
+    print "  downloading git repository.. this may take a while.."
+    app_path = Laravel::Tests::app_downloads_nicely? options
+
+    # expectations
+    app_path.should be_nil
+    !Laravel::local_repository_exists?(options[:remote])
+    !Laravel::Tests::download_was_performed?(app_path)
+  end
+
+  it "should download source from the official repository" do
+    # preparations
+    Laravel::Tests::cleanup Laravel::OfficialRepository
+
+    # actions
+    print "  downloading git repository.. this may take a while.."
+    app_path = Laravel::Tests::app_downloads_nicely?
+
+    # expectations
+    app_path.should_not be_nil
+    Laravel::local_repository_exists?(Laravel::OfficialRepository)
+    Laravel::Tests::download_was_performed?(app_path)
+  end
+
+  it "should copy source from local repository cache" do
+    # preparations
+    # should only be run with the previous test
+    # act as cached repo
+    options = { :remote => Laravel::crypted_path(Laravel::OfficialRepository) }
+
+    # actions
+    app_path = Laravel::Tests::app_downloads_nicely?
+
+    # expectations
+    app_path.should_not be_nil
+    Laravel::Tests::download_was_performed?(app_path)
+  end
+
+  it "should copy source from a manually specified directory" do
+    # preparations
+    # acts as local directory
+    options = { :local => Laravel::crypted_path(Laravel::OfficialRepository) }
+
+    # actions
+    app_path = Laravel::Tests::app_downloads_nicely? options
+
+    # expectations
+    app_path.should_not be_nil
+    Laravel::Tests::download_was_performed?(app_path)
+  end
+
+end

data/spec/laravel/laravel_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Laravel do
+  it "should have a version" do
+    Laravel::VERSION.should_not be_nil
+  end
+
+  context "when creating a new application" do
+
+    before(:each) { Laravel::Tests::cleanup }
+    after(:each)  { Laravel::Tests::cleanup }
+
+    it "should run with default options" do
+      # actions
+      print '    downloading git repository.. this may take a while..'
+      app_path = Laravel::Tests::app_downloads_nicely?
+
+      # expectations
+      app_path.should_not be_nil
+      Laravel::Tests::app_was_created? app_path
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'laravel'
+
+module Laravel
+  class Tests
+    TestAppDirectory = File.join( File.dirname(__FILE__), %w[ .. __tests ] )
+
+    # get path to the test application
+    def self.app_path(app_name)
+      File.join(Laravel::Tests::TestAppDirectory, app_name)
+    end
+
+    # perform an application download using Laravel::Download
+    def self.app_downloads_nicely?(options = {}, app_name = "")
+      app_name ||= (('a'..'z').to_a+('A'..'Z').to_a).shuffle[0,32].join
+      options[:quiet] = true
+      app_path   = Laravel::Tests::app_path app_name
+      error      = Laravel::Download::source(app_path, options)
+      error ? nil : app_path
+    end
+
+    # check if the download was successful
+    def self.download_was_performed?(app_path)
+      app_path && File.directory?(app_path)
+    end
+
+    # check if the application was created?
+    def self.app_was_created?(app_path)
+      return false unless Laravel::Tests::download_was_performed?(app_path)
+      return false unless Laravel::has_laravel?(app_path)
+      true
+    end
+
+    # cleanup before and after our tests
+    def self.cleanup(repo = "")
+      FileUtils.rm_rf Laravel::Tests::TestAppDirectory
+      FileUtils.rm_rf Laravel::crypted_path(repo) if repo
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.fail_fast = true
+  c.color = true
+  c.formatter = :documentation
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: laravel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,23 +9,114 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
-dependencies: []
+date: 2012-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A wrapper around Laravel framework for PHP
 email:
 - me@nikhgupta.com
-executables: []
+executables:
+- laravel
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/laravel
 - laravel.gemspec
 - lib/laravel.rb
+- lib/laravel/download.rb
+- lib/laravel/helpers.rb
+- lib/laravel/info.rb
 - lib/laravel/version.rb
+- repositories/.gitkeep
+- spec/laravel/download/download_spec.rb
+- spec/laravel/laravel_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/laravel
 licenses: []
 post_install_message: 
@@ -52,4 +143,7 @@ specification_version: 3
 summary: This gem is a wrapper around the Laravel framework for PHP. Initially, the
   gem would allow to create new laravel apps along with options to modify the default
   behavior for these new installations.
-test_files: []
+test_files:
+- spec/laravel/download/download_spec.rb
+- spec/laravel/laravel_spec.rb
+- spec/spec_helper.rb