wordless 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3da29df733fc405d1627fb449aa30b9fc9caf92b
-  data.tar.gz: 9c5bfd9561d5738dc776c89fc20e81a6687f4905
+  metadata.gz: 1f22b77e330965f615984ee5c3be29046326bf6e
+  data.tar.gz: ab9e5f45f3cebe1001c0bea379908643b9c89a00
 SHA512:
-  metadata.gz: d649552b3e245354cfd89d4e985929fe055bd457ec10be01091137b0006a0aa65fd8212a0578319dc2e2b7adfa544b57e8b65c0c49e4ad956fcee55d8caf1ce2
-  data.tar.gz: d3e7a3c362182c41b3ba2d7b7772be481e689daf7cc4627eee79a85e5b93c5304c8a804745433059d525ab10a06983a37106ffe735d50cb7d21454ea2104bfb5
+  metadata.gz: 7adeb159e0616070e27504d02f16cc7c3922c437bfa5fb26e84adc2859b07326fc4457d1107f7a500a5c7a220c5ced15fc0ce3d2a0d18a8cd8a812562f8fd758
+  data.tar.gz: dcde2ab35695d7766e628ac9b18c366fc37ae6da4ef32aace5e005a4e085c6e2461c989955e518f35c11f1c3235ce81bf6bacdd70b204905891c109e5903ee1d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wordless (0.4.0)
+    wordless (0.4.1)
       activesupport
       coffee-script
       compass

data/README.mdown

@@ -2,6 +2,8 @@
 
 A command line tool to help manage your [Wordless](http://welaika.github.com/wordless/)-based WordPress sites.
 
+[![Build Status](https://travis-ci.org/welaika/wordless_gem.png?branch=master)](https://travis-ci.org/welaika/wordless_gem)
+
 ## Premise
 
 This is a ruby-gem, so we expect you have already installed _ruby_; if it isn't
@@ -95,11 +97,11 @@ deploy_command: 'wordmove push -t'
 ## Caveats
 
 - If you attempt to download a WordPress localization that's outdated, the latest English version will be downloaded instead.
-- Only tested on Mac OS X
+- Not tested on Windows
 
 ## Running specs
 
-    bundle install && ./setup_tests && rspec
+    bundle install && ./setup_tests.sh && rspec
 
 ## Contributing
 

data/lib/wordless/version.rb

@@ -1,3 +1,3 @@
 module Wordless
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/lib/wordless/wordless_cli.rb

@@ -5,14 +5,56 @@ module Wordless
     include WordPressTools::CLIHelper
     attr_reader :options, :thor
 
+    module PATH
+      WORDFILE   = :wordfile
+      WP_CONTENT = :wp_content
+      PLUGINS    = :plugins
+      THEMES     = :themes
+    end
+
+    DEFAULT_PATHS = {
+      PATH::WORDFILE   => 'Wordfile',
+      PATH::WP_CONTENT => 'wp-content',
+      PATH::PLUGINS    => 'wp-content/plugins',
+      PATH::THEMES     => 'wp-content/themes',
+    }
+
+    DEFAULT_PATHS.each do |type, value|
+      define_method "#{type}_path" do
+        value
+      end
+    end
+
     def lib_dir
       @@lib_dir ||= File.expand_path(File.dirname(__FILE__))
     end
 
+    def wordpress_dir(current_dir = start_dir)
+      @wordpress_dir ||= (
+        current_dir = File.expand_path(current_dir)
+
+        if File.exists? File.join(current_dir, wp_content_path)
+          current_dir
+        elsif last_dir?(current_dir)
+          raise StandardError, "Could not find a valid Wordpress directory"
+        else
+          wordpress_dir(upper_dir(current_dir))
+        end
+      )
+    end
+
+    def last_dir?(directory)
+      directory == "/"
+    end
+
+    def upper_dir(directory)
+      File.join(directory, '..')
+    end
+
     def config
       @@config ||= (
-        if File.exists?('Wordfile')
-          YAML::load(File.open('Wordfile')).symbolize_keys
+        if File.exists?(wordfile_path)
+          YAML::load(File.open(wordfile_path)).symbolize_keys
         else
           {}
         end
@@ -38,35 +80,40 @@ module Wordless
     end
 
     def install
+      at_wordpress_root!
+
       unless git_installed?
         error "Git is not available. Please install git."
       end
 
-      unless File.directory? 'wp-content/plugins'
-        error "Directory 'wp-content/plugins' not found. Make sure you're at the root level of a WordPress installation."
-      end
-
-      if run_command "git clone #{wordless_repo} wp-content/plugins/wordless"
-        success "Installed Wordless plugin."
+      if File.directory?(plugins_path)
+        if run_command "git clone #{wordless_repo} #{wordless_plugin_path}"
+          success "Installed Wordless plugin."
+        else
+          error "There was an error installing the Wordless plugin."
+        end
       else
-        error "There was an error installing the Wordless plugin."
+        error "Directory '#{plugins_path}' not found."
       end
     end
 
     def theme(name)
-      if File.directory? 'wp-content/themes'
-        # Run PHP helper script
+      at_wordpress_root!
+
+      if File.directory?(themes_path)
         if system "php #{File.join(lib_dir, 'theme_builder.php')} #{name}"
-          success "Created a new Wordless theme in 'wp-content/themes/#{name}'."
+          success "Created a new Wordless theme in '#{File.join(themes_path, name)}'."
         else
           error "Couldn't create Wordless theme."
         end
       else
-        error "Directory 'wp-content/themes' not found. Make sure you're at the root level of a WordPress installation."
+        error "Directory '#{themes_path}' not found."
       end
     end
 
     def compile
+      at_wordpress_root!
+
       if system "php #{File.join(lib_dir, 'compile_assets.php')}"
         success "Compiled static assets."
       else
@@ -75,7 +122,9 @@ module Wordless
     end
 
     def clean
-      if File.directory? 'wp-content/themes'
+      at_wordpress_root!
+
+      if File.directory?(themes_path)
         static_css = Array(config[:static_css] || Dir['wp-content/themes/*/assets/stylesheets/screen.css'])
         static_js = Array(config[:static_js] || Dir['wp-content/themes/*/assets/javascripts/application.js'])
 
@@ -85,14 +134,12 @@ module Wordless
 
         success "Cleaned static assets."
       else
-        error "Directory 'wp-content/themes' not found. Make sure you're at the root level of a WordPress installation."
+        error "Directory '#{themes_path}' not found."
       end
     end
 
     def deploy
-      unless File.exists? 'wp-config.php'
-        error "WordPress not found. Make sure you're at the root level of a WordPress installation."
-      end
+      at_wordpress_root!
 
       compile if options['refresh']
 
@@ -109,6 +156,18 @@ module Wordless
 
     private
 
+    def start_dir
+      "."
+    end
+
+    def at_wordpress_root!
+      Dir.chdir(wordpress_dir)
+    end
+
+    def wordless_plugin_path
+      File.join(plugins_path, "wordless")
+    end
+
     def wordless_repo
       config[:wordless_repo] || 'git://github.com/welaika/wordless.git'
     end

data/spec/cli_spec.rb

@@ -34,56 +34,57 @@ describe Wordless::CLI do
     end
   end
 
+  context "without a valid WordPress install" do
+    before do
+      FileUtils.mkdir_p('wordpress/wp-content') && Dir.chdir('wordpress')
+    end
+
+    it "fails to install the Wordless plugin" do
+      content = capture(:stdout) { Wordless::CLI.start ['install'] }
+      content.should =~ %r|Directory 'wp-content/plugins' not found|
+    end
+
+    it "fails to create a Wordless theme" do
+      content = capture(:stdout) { Wordless::CLI.start ['theme', 'mytheme'] }
+      content.should =~ %r|Directory 'wp-content/themes' not found|
+    end
+  end
+
   context "#install" do
-    context "with a valid WordPress installation" do
-      it "installs the Wordless plugin" do
-        WordPressTools::CLI.start ['new']
-        Dir.chdir 'wordpress'
-        Wordless::CLI.start ['install']
-        File.directory?('wp-content/plugins/wordless').should be_true
-      end
+    before do
+      WordPressTools::CLI.start ['new']
+      Dir.chdir 'wordpress'
     end
 
-    context "without a valid WordPress installation" do
-      it "fails to install the Wordless plugin" do
-        content = capture(:stdout) { Wordless::CLI.start ['install'] }
-        content.should =~ %r|Directory 'wp-content/plugins' not found|
-      end
+    it "installs the Wordless plugin" do
+      Wordless::CLI.start ['install']
+      File.directory?('wp-content/plugins/wordless').should be_true
     end
   end
 
   context "#theme" do
-    context "with a valid WordPress installation and the Wordless plugin" do
-      before :each do
-        WordPressTools::CLI.start ['new']
-        Dir.chdir 'wordpress'
-        Wordless::CLI.start ['install']
-      end
-
-      it "creates a Wordless theme" do
-        Wordless::CLI.start ['theme', 'mytheme']
-        File.directory?('wp-content/themes/mytheme').should be_true
-        File.exists?('wp-content/themes/mytheme/index.php').should be_true
-      end
+    before do
+      WordPressTools::CLI.start ['new']
+      Dir.chdir 'wordpress'
+      Wordless::CLI.start ['install']
     end
 
-    context "without a valid WordPress installation" do
-      it "fails to create a Wordless theme" do
-        content = capture(:stdout) { Wordless::CLI.start ['theme', 'mytheme'] }
-        content.should =~ %r|Directory 'wp-content/themes' not found|
-      end
+    it "creates a Wordless theme" do
+      Wordless::CLI.start ['theme', 'mytheme']
+      File.directory?('wp-content/themes/mytheme').should be_true
+      File.exists?('wp-content/themes/mytheme/index.php').should be_true
     end
   end
 
-  context "#compile" do
-    context "with a valid Wordless installation" do
+  context "with a working Wordless install" do
+    before do
+      Wordless::CLI.start ['new', 'myapp']
+    end
+
+    context "#compile" do
       let(:compiled_css) { 'wp-content/themes/myapp/assets/stylesheets/screen.css' }
       let(:compiled_js) { 'wp-content/themes/myapp/assets/javascripts/application.js' }
 
-      before :each do
-        Wordless::CLI.start ['new', 'myapp']
-      end
-
       it "compiles static assets" do
         Wordless::CLI.start ['compile']
 
@@ -94,90 +95,84 @@ describe Wordless::CLI do
         File.readlines(compiled_js).grep(/return "Yep, it works!";/).should_not be_empty
       end
     end
-  end
 
-  context "#clean" do
-    before do
-      FileUtils.mkdir_p('myapp/wp-content/themes/myapp/assets/stylesheets')
-      FileUtils.mkdir_p('myapp/wp-content/themes/myapp/assets/javascripts')
-      Dir.chdir('myapp')
-    end
+    context "#clean" do
+      before do
+        FileUtils.mkdir_p('wp-content/themes/myapp/assets/stylesheets')
+        FileUtils.mkdir_p('wp-content/themes/myapp/assets/javascripts')
+      end
 
-    let(:default_css) { 'wp-content/themes/myapp/assets/stylesheets/screen.css' }
-    let(:default_js) { 'wp-content/themes/myapp/assets/javascripts/application.js' }
+      let(:default_css) { 'wp-content/themes/myapp/assets/stylesheets/screen.css' }
+      let(:default_js) { 'wp-content/themes/myapp/assets/javascripts/application.js' }
 
-    let(:first_css)  { 'wp-content/themes/myapp/assets/stylesheets/foo.css' }
-    let(:second_css) { 'wp-content/themes/myapp/assets/stylesheets/bar.css' }
-    let(:first_js)   { 'wp-content/themes/myapp/assets/javascripts/robin.js' }
-    let(:second_js)  { 'wp-content/themes/myapp/assets/javascripts/galahad.js' }
+      let(:first_css)  { 'wp-content/themes/myapp/assets/stylesheets/foo.css' }
+      let(:second_css) { 'wp-content/themes/myapp/assets/stylesheets/bar.css' }
+      let(:first_js)   { 'wp-content/themes/myapp/assets/javascripts/robin.js' }
+      let(:second_js)  { 'wp-content/themes/myapp/assets/javascripts/galahad.js' }
 
-    it "should remove default default assets" do
-      FileUtils.touch(default_css)
-      FileUtils.touch(default_js)
+      it "should remove default default assets" do
+        FileUtils.touch(default_css)
+        FileUtils.touch(default_js)
 
-      Wordless::CLI.start ['clean']
+        Wordless::CLI.start ['clean']
 
-      File.exists?(default_css).should be_false
-      File.exists?(default_js).should be_false
-    end
+        File.exists?(default_css).should be_false
+        File.exists?(default_js).should be_false
+      end
 
-    it "should remove assets specified on config" do
-      Wordless::WordlessCLI.class_variable_set :@@config, {
-        :static_css => [ first_css, second_css ],
-        :static_js =>  [ first_js, second_js ]
-      }
+      it "should remove assets specified on config" do
+        Wordless::WordlessCLI.class_variable_set :@@config, {
+          :static_css => [ first_css, second_css ],
+          :static_js =>  [ first_js, second_js ]
+        }
 
-      [ first_css, second_css, first_js, second_js ].each do |file|
-        FileUtils.touch(file)
-      end
+        [ first_css, second_css, first_js, second_js ].each do |file|
+          FileUtils.touch(file)
+        end
 
-      Wordless::CLI.start ['clean']
+        Wordless::CLI.start ['clean']
 
-      [ first_css, second_css, first_js, second_js ].each do |file|
-        File.exists?(file).should be_false
+        [ first_css, second_css, first_js, second_js ].each do |file|
+          File.exists?(file).should be_false
+        end
       end
     end
-  end
-
-  context "#deploy" do
-
-    let(:cli)  { Wordless::CLI.new }
-    let(:file) { 'shrubbery.txt' }
-    let(:wordless_cli)  { Wordless::WordlessCLI.new({}, Thor.new) }
 
-    before do
-      FileUtils.mkdir_p('myapp') and Dir.chdir('myapp')
-      FileUtils.touch('wp-config.php')
-    end
+    context "#deploy" do
+      let(:cli)  { Wordless::CLI.new }
+      let(:file) { 'shrubbery.txt' }
+      let(:wordless_cli)  { Wordless::WordlessCLI.new({}, Thor.new) }
 
-    before do
-      cli.stub(:wordless_cli).and_return(wordless_cli)
-      Wordless::WordlessCLI.class_variable_set :@@config, {
-        :deploy_command => "touch #{file}"
-      }
-    end
+      before do
+        cli.stub(:wordless_cli).and_return(wordless_cli)
+        Wordless::WordlessCLI.class_variable_set :@@config, {
+          :deploy_command => "touch #{file}"
+        }
+      end
 
-    it "should deploy via the deploy command" do
-      cli.deploy
-      File.exists?(file).should be_true
-    end
+      it "should deploy via the deploy command" do
+        cli.deploy
+        File.exists?(file).should be_true
+      end
 
-    it "should compile and clean if refresh option is passed" do
-      wordless_cli.should_receive(:compile).and_return(true)
-      wordless_cli.should_receive(:clean).and_return(true)
-      wordless_cli.stub(:options).and_return({ 'refresh' => true })
+      it "should compile and clean if refresh option is passed" do
+        wordless_cli.should_receive(:compile).and_return(true)
+        wordless_cli.should_receive(:clean).and_return(true)
+        wordless_cli.stub(:options).and_return({ 'refresh' => true })
 
-      cli.deploy
-    end
+        cli.deploy
+      end
 
-    context "if a custom deploy is passed" do
-      let(:file) { 'knights.txt' }
+      context "if a custom deploy is passed" do
+        let(:file) { 'knights.txt' }
 
-      it "should launch the custom deploy command" do
-        wordless_cli.stub(:options).and_return({ 'command' => "touch #{file}" })
-        cli.deploy
-        File.exists?(file).should be_true
+        it "should launch the custom deploy command" do
+          wordless_cli.stub(:options).and_return({ 'command' => "touch #{file}" })
+          cli.deploy
+          File.exists?(file).should be_true
+        end
       end
     end
   end
+
 end

data/spec/spec_helper.rb

@@ -10,35 +10,33 @@ module WordPressTools
   end
 end
 
-RSpec.configure do |config|
+module Wordless
+  class WordlessCLI
+    def error(message)
+      puts message
+    end
+  end
+end
 
+require 'support/capture'
+
+WP_API_RESPONSE = <<-EOF
+  upgrade
+  http://wordpress.org/download/
+  http://wordpress.org/wordpress-3.6.zip
+  3.6
+  en_US
+  5.2.4
+  5.0
+EOF
+
+RSpec.configure do |config|
   config.before(:all) do
     FileUtils.mkdir('tmp') unless File.directory? 'tmp'
     FakeWeb.allow_net_connect = false
-    WP_API_RESPONSE = <<-eof
-        upgrade
-        http://wordpress.org/download/
-        http://wordpress.org/wordpress-3.6.zip
-        3.6
-        en_US
-        5.2.4
-        5.0
-    eof
+
     FakeWeb.register_uri(:get, %r|http://api.wordpress.org/core/version-check/1.5/.*|, :body => WP_API_RESPONSE)
     FakeWeb.register_uri(:get, "http://wordpress.org/wordpress-3.6.zip", :body => File.expand_path('spec/fixtures/wordpress_stub.zip'))
   end
-
-  # utility to log commands output or errors
-  def capture(stream)
-    begin
-      stream = stream.to_s
-      eval "$#{stream} = StringIO.new"
-      yield
-      result = eval("$#{stream}").string
-    ensure
-      eval("$#{stream} = #{stream.upcase}")
-    end
-
-    result
-  end
 end
+

data/spec/support/capture.rb

@@ -0,0 +1,18 @@
+module CaptureHelpers
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+end
+
+RSpec.configure do |config|
+  config.include CaptureHelpers
+end

data/spec/wordless/wordless_cli_spec.rb

@@ -0,0 +1,54 @@
+require 'wordless/wordless_cli'
+
+describe Wordless::WordlessCLI do
+  let(:cli) { Wordless::WordlessCLI.new }
+
+  context "#wordpress_dir" do
+    TMPDIR = "/tmp/wordless"
+
+    let(:wp_content) { File.join(TMPDIR, "wp-content") }
+
+    before do
+      @original_dir = Dir.pwd
+      FileUtils.mkdir(TMPDIR)
+      Dir.chdir(TMPDIR)
+    end
+
+    after do
+      Dir.chdir(@original_dir)
+      FileUtils.rm_rf(TMPDIR)
+    end
+
+    context "if a wordpress directory is found" do
+      before do
+        FileUtils.mkdir(wp_content)
+      end
+
+      it 'returns the directory' do
+        expect(cli.wordpress_dir).to eq(File.expand_path("."))
+      end
+    end
+
+    context "if no wordpress directory is found" do
+      it 'raises an error' do
+        expect { cli.wordpress_dir }.to raise_error(StandardError)
+      end
+    end
+
+    context "directory traversal" do
+      before do
+        FileUtils.mkdir(wp_content)
+
+        @test_dir = File.join(TMPDIR, "test")
+        FileUtils.mkdir(@test_dir)
+        Dir.chdir(@test_dir)
+      end
+
+      it 'goes up through the directory tree and finds it' do
+        expect(cli.wordpress_dir).to eq(File.expand_path("./.."))
+      end
+
+    end
+  end
+end
+

data/wordless.gemspec

@@ -6,6 +6,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Command line tool to manage Wordless themes.}
   gem.summary       = %q{Manage Wordless themes.}
   gem.homepage      = "http://github.com/welaika/wordless_gem"
+  gem.license       = "MIT"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordless
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Étienne Després
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -168,9 +168,12 @@ files:
 - spec/fixtures/wordpress_stub.zip
 - spec/fixtures/zipped_file.zip
 - spec/spec_helper.rb
+- spec/support/capture.rb
+- spec/wordless/wordless_cli_spec.rb
 - wordless.gemspec
 homepage: http://github.com/welaika/wordless_gem
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -198,3 +201,5 @@ test_files:
 - spec/fixtures/wordpress_stub.zip
 - spec/fixtures/zipped_file.zip
 - spec/spec_helper.rb
+- spec/support/capture.rb
+- spec/wordless/wordless_cli_spec.rb