pave 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51010f11d688daf56a02e4d565813dcec29436dc
-  data.tar.gz: a2e67566e859660b1f2ad07c0748ed6075b200ce
+  metadata.gz: 73f1328426b5077aeaa1d8f9a7056cb0d23f4966
+  data.tar.gz: 6d44d7901e194239707394d3c46739a71c358869
 SHA512:
-  metadata.gz: a0dee91466eb5f6092fcf3c7be14e66791ad505628a364ebabbeb214b8333e6d484d9f8db107c135a7de6e0ff16fa2a24bf7659b84209ebf7c07053c389b441b
-  data.tar.gz: 0d3cc447999ccb062a9b87d237c58e060f896d53e0c215d641ff43bf9dd997bba83d297e5f7739f4ba088d683327f4146f05e8b14b190c7539c54f508efcd8b3
+  metadata.gz: a4cd5bb23917e1b6d991a298409cefbb36e0c649ddb8e9d3bbd50e384e7d0df7e5d7f043b2be73f58d412a213076eb90fef38c8afee1369efe9dff248074272a
+  data.tar.gz: dce87fdfcb7ef23f116001cde04e2fcb1b134856432dec4462555e7367bfb1120de4a5bb1f270d4dfa2c69c93391dd8060e332ad6b258e4c3ef0ac04fed69406

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pave (0.2.3)
+    pave (0.4.3999)
       commander (~> 4.1.5)
 
 GEM

data/README.md

@@ -1,52 +1,89 @@
 # pave - Command line tools for Concrete5 websites
 
-Author: Jamon Holmgren (@jamonholmgren)
+Authors: Jamon Holmgren (@jamonholmgren), Ryan Linton (@ryanlntn)
 
-Provides a set of command line tools for Concrete5.
+Provides a set of command line tools for setting up and developing [Concrete5](http://www.concrete5.org/) websites.
 
-## Installation
+*Requirements:* Designed for Ruby 2.0+ running on OS X Mavericks.
+
+# Installation
 
     $ gem install pave
 
-## Usage
+# Usage
 
-#### Create a new Concrete5 website:
+## Create a new Concrete5 website
 
     $ pave new mywebsite
 
 This:
 
-1. Downloads Concrete 5.6.2.1
+1. Downloads Concrete 5.6.2.1 (once) into `~/.pave`
 2. Unzips it into `mywebsite`
-3. Removes extra folders
-4. Builds an app folder of commonly used folders (symlinked into the root folder so Concrete5 can find them)
-5. Initializes a Git repo and adds the first ("Initial") commit.
+3. Removes extra folders and sets up folder permissions
+4. Adds a `.gitignore` and `.keep`s
+5. Attempts to create a virtual host `mywebsite.site`
 
-#### Deployments
+## Deployments
 
     $ pave deploy:setup
 
-This sets up a deployment script to the remote server and deploys an initial version.
+This sets up a Git-based deployment script to the remote server and deploys an initial version. SSH access is required.
 
     $ pave deploy
 
 Deploys the site using git.
 
-#### Database
+## Database
+
+    $ pave db:create mydatabase
 
-TODO:
+Creates a local MySQL database called `mydatabase`
 
-    $ pave db:create
     $ pave db:push
+
+*TODO:* Copies the local Concrete5 database to the remote database. Useful for deploying to staging sites.
+
     $ pave db:pull
-    $ pave db:backup
 
-#### Help
+*TODO:* Copies the remote Concrete5 database into the local database. Useful for obtaining production data for testing.
+
+    $ pave db:dump
+
+Creates a database dump file and places it in `.db/YYYY-MM-DD-database.sql.gz`.
+
+## Virtual host setup
+
+    $ pave vh:create myhost.site
+
+Sets up an Apache virtual host in the current directory on `myhost.site`.
+
+    $ pave vh:remove myhost.site
+
+Removes myhost.site virtual host.
+
+    $ pave vh:backup
+
+Backs up your hosts file and vhost file.
+
+    $ pave vh:restore
+
+Restores your previously backed up virtual host file.
+
+    $ pave vh:restart
+
+Restarts Apache.
+
+## Help
+
+    $ pave help
 
-    $ pave --help
-    
 Outputs common tasks that pave can do.
 
+## Updating
+
+    $ pave update
+
 ## Contributing
 
 0. Create an issue explaining what you'd like to do and get feedback

data/bin/pave

@@ -130,20 +130,39 @@ command :"db:dump" do |c|
     Pave::Database.new(name).dump
   end
 end
+alias_command :"db:backup", :"db:dump"
 
-command :"db:download" do |c|
-  c.syntax = "pave db:download"
+command :"db:pull" do |c|
+  c.syntax = "pave db:pull"
   c.description = "Download the project's live database and replace local database."
   c.action do |args|
-    say "`db:download` command not implemented yet."
+    say "`db:pull` command not implemented yet."
   end
 end
 
-command :"db:upload" do |c|
-  c.syntax = "pave db:upload"
+command :"db:push" do |c|
+  c.syntax = "pave db:push"
   c.description = "Upload the project's local database and replace the live database."
   c.action do |args|
-    say "`db:upload` command not implemented yet."
+    say "`db:push` command not implemented yet."
+  end
+end
+
+command :"generate:theme" do |c|
+  c.syntax = "pave generate:theme THEME_NAME"
+  c.description = "Set up a blank theme with sass."
+  c.action do |args|
+    name = args.first || "#{File.basename(Dir.pwd)}"
+    Pave::Theme.create(name)
+  end
+end
+alias_command :"g:theme", :"generate:theme"
+
+command :watch do |c|
+  c.syntax = "pave watch"
+  c.description = "Watch for sass changes."
+  c.action do |args|
+    Pave::Theme.watch
   end
 end
 
@@ -151,7 +170,7 @@ command :"deploy" do |c|
   c.syntax = "pave deploy"
   c.description = "Deploy project to web server."
   c.action do |args|
-    remote = args[0] || "production"
+    remote = args[0] || "live"
     branch = args[1] || "master"
     Pave::Deploy.new.deploy(remote, branch)
   end

data/lib/pave/concrete.rb

@@ -16,6 +16,7 @@ module Pave
     end
 
     def setup
+      set_up_pave
       clone_concrete5
       set_up_folders
       set_up_git
@@ -23,15 +24,19 @@ module Pave
       self
     end
 
+    def set_up_pave
+      sh "mkdir ~/.pave" unless File.exists?(File.join(Dir.home, ".pave/"))
+    end
+
     def clone_concrete5
-      say "* Downloading Concrete5 version 5.6.2.1..."
-      sh "curl http://www.concrete5.org/download_file/-/view/58379/8497 -o c5.zip > /dev/null"
-      say ""
-      say "* Unzipping..."
-      sh "unzip c5.zip"
-      sh "rm c5.zip"
-      sh "mv concrete5.6.2.1 #{name}"
-      say "* Concrete5 downloaded and unzipped into ./#{name}."
+      c5 = "concrete5.6.2.1"
+      c5_link = "http://www.concrete5.org/download_file/-/view/58379/8497"
+      unless File.exists?(File.join(Dir.home, ".pave/#{c5}.zip"))
+        say "* Downloading #{c5}..."
+        sh "curl #{c5_link} > ~/.pave/#{c5}.zip"
+      end
+      say "* Copying Concrete5 into #{name}..."
+      sh "unzip -qq ~/.pave/#{c5}.zip && mv #{c5} #{name}"
     end
 
     def set_up_folders
@@ -56,7 +61,9 @@ module Pave
         "files/incoming/*",
         "files/thumbnails/*",
         "files/tmp/*",
-        "files/trash/*"
+        "files/trash/*",
+        ".sass-cache",
+        "stylesheets"
       ]
     end
 
@@ -88,7 +95,7 @@ module Pave
     end
 
     def world_writable_folders
-      %w{ config packages files }
+      %w{ blocks config packages files }
     end
 
     def gitkeep_folders

data/lib/pave/database.rb

@@ -20,8 +20,16 @@ module Pave
     end
 
     def dump
-      say "Creating dump of #{name} at #{Dir.pwd}/#{Time.now.strftime("%Y-%m-%d")}-#{name}.sql.gz"
-      sh "mysqldump -uroot #{name} | gzip > #{Time.now.strftime("%Y-%m-%d")}-#{name}.sql.gz"
+      if !File.directory?('db')
+        sh "mkdir ./db"
+        sh "echo '<?= die(); ?>' > ./db/index.php"
+        sh "echo 'deny from all' > ./db/.htaccess"
+        sh "sudo chmod -R 700 ./db/"
+      end
+      dbname = Time.now.strftime("%Y-%m-%d-%H%M") + "-" + name + ".sql.gz"
+      say "Creating dump of #{name} at #{Dir.pwd}/db/#{dbname}"
+      sh "mysqldump -uroot #{name} | gzip > ./db/#{dbname}"
+      say "Dump complete."
     end
 
     def download(host, user, password)

data/lib/pave/deploy.rb

@@ -5,7 +5,7 @@ module Pave
     def setup
       server = ask "Username and hostname of the remote server (e.g. user@server.com): "
       folder = ask "Name of the remote directory (e.g. ~/webapps/appname/): "
-      remote = ask "Desired git remote name (e.g. production): "
+      remote = ask "Desired git remote name (e.g. live): "
       script = File.join(File.expand_path("../..", File.dirname(__FILE__)), "resources/deploy.sh")
 
       puts "Piping shell script to #{server} for setup."
@@ -17,7 +17,7 @@ module Pave
       puts "Finished! You may now run `pave deploy` to deploy your application."
     end
 
-    def deploy(remote="production", branch="master")
+    def deploy(remote="live", branch="master")
       sh "git push #{remote} #{branch}"
     end
   end

data/lib/pave/theme.rb

@@ -0,0 +1,62 @@
+require "pave/shell"
+
+module Pave
+  class Theme
+    include Pave::Shell
+
+    attr_reader :name
+
+    def self.create(name)
+      new(name).setup
+    end
+
+    def self.watch
+      `sass --watch ./themes/ --style compressed`
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def install_sass
+      say "Installing SASS..."
+      sh "gem install sass"
+    end
+
+    def install_bourbon
+      say "Installing Bourbon..."
+      sh "gem install bourbon"
+      sh "cd themes/#{self.name}/css/ && bourbon install && cd -"
+    end
+
+    def install_neat
+      say "Installing Neat..."
+      sh "gem install neat"
+      sh "cd themes/#{self.name}/css/ && neat install && cd -"
+    end
+
+    def install_bitters
+      say "Installing Bitters"
+      sh "gem install bitters"
+      sh "cd themes/#{self.name}/css/ && bitters install && cd -"
+    end    
+
+    def copy_theme
+      sh "cp -a #{Pave.template_folder}/themes/blank #{Dir.pwd}/themes/#{self.name}"
+    end
+
+    def setup
+      say "Creating theme..."
+      copy_theme
+      install_sass
+      install_bourbon
+      install_neat
+      install_bitters
+      say "Docs for Neat: http://neat.bourbon.io/"
+      say "Docs for Bitters: https://github.com/thoughtbot/bitters"
+      say ""
+      say "Theme installed. Run `pave watch` to generate css from your sass files."
+    end
+
+  end
+end

data/lib/pave/version.rb

@@ -1,3 +1,3 @@
 module Pave
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/pave.rb

@@ -4,6 +4,7 @@ require "pave/shell"
 require "pave/concrete"
 require "pave/database"
 require "pave/virtual_host"
+require "pave/theme"
 require "pave/deploy"
 
 module Pave
@@ -13,4 +14,10 @@ module Pave
     ($? == 0) ? (say "Updated") : (say "Update failed. Run `gem update pave` manually.")
   end
   module_function :update
+
+  def template_folder 
+    script = File.join(File.expand_path("../", File.dirname(__FILE__)), "templates")
+  end  
+  module_function :template_folder
+
 end

data/templates/themes/blank/css/styles.scss

@@ -0,0 +1,2 @@
+@import 'bourbon/_bourbon';
+@import 'neat/_neat';

data/templates/themes/blank/default.php

@@ -0,0 +1,12 @@
+<?php  
+  defined('C5_EXECUTE') or die("Access Denied.");
+  $this->inc('elements/header.php');
+?>
+
+	<?php
+	  $a = new Area('Main');    
+	  $a->display($c);
+	?>
+
+    
+<?php  $this->inc('elements/footer.php'); ?>

data/templates/themes/blank/description.txt

@@ -0,0 +1,2 @@
+Theme
+If you don't know what you are doing, do NOT change the theme, as it will break the website! | Theme developed by ... | All Rights Reserved

data/templates/themes/blank/elements/footer.php

@@ -0,0 +1,13 @@
+		<?php   defined('C5_EXECUTE') or die("Access Denied."); ?>
+
+
+    <?php  
+      $a = new GlobalArea('Footer - Meta');
+      $a->display($c);
+    ?>    
+
+
+		<?php   Loader::element('footer_required'); ?>
+    <script src='<?= $this->getThemePath(); ?>/js/scripts.js'></script>
+	</body>
+</html>

data/templates/themes/blank/elements/header.php

@@ -0,0 +1,36 @@
+<?php   defined('C5_EXECUTE') or die("Access Denied.");
+  $this->inc('includes/view_helpers.php');
+?>
+<!DOCTYPE html>
+<html lang="<?php echo LANGUAGE?>">
+  <head>
+    <?php   Loader::element('header_required'); ?>
+
+    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/normalize/2.1.3/normalize.min.css" />
+    <link rel="stylesheet" href="<?= $this->getThemePath(); ?>/css/styles.css" />
+
+    <!--[if lt IE 9]>
+      <script src='//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.6.2/html5shiv.js'></script>
+    <![endif]-->
+  </head>
+
+	<body class="<?= $c->getCollectionTypeHandle(); ?>">
+
+
+    <!-- BLOCK EXAMPLE -->
+    <?php
+      $a = new Area('Header');
+      $a->display($c);
+    ?>
+
+
+    <!-- NAV EXAMPLE -->
+    <?php
+      $nav = BlockType::getByHandle('autonav');
+      $nav->controller->orderBy = 'display_asc';
+      $nav->controller->displayPages = 'top';
+      $nav->controller->displaySubPages = 'all';
+      $nav->controller->displaySubPageLevels = 'custom';
+      $nav->controller->displaySubPageLevelsNum = 1;
+      $nav->render('templates/header_menu');
+    ?>

data/templates/themes/blank/includes/view_helpers.php

@@ -0,0 +1,14 @@
+<?
+  function editmode() {
+    global $c;
+    if ($c->isEditMode()) {
+      echo "editMode";
+    }
+  }
+
+  function image_tag($t, $img) {
+    $imgPath = ($t->getThemePath()) . "/images/";
+    echo "<img src='" . $imgPath . $img . "' />";
+  } 
+
+?>

data/templates/themes/blank/js/scripts.js

@@ -0,0 +1,7 @@
+$(document).ready(function(){
+
+
+
+
+
+});

data/templates/themes/blank/view.php

@@ -0,0 +1,8 @@
+<?php  
+   defined('C5_EXECUTE') or die("Access Denied.");
+   $this->inc('elements/header.php'); 
+?>
+
+	<?php  print $innerContent; ?>
+	
+<?php  $this->inc('elements/footer.php'); ?>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pave
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jamon Holmgren
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2013-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,10 +103,20 @@ files:
 - lib/pave/database.rb
 - lib/pave/deploy.rb
 - lib/pave/shell.rb
+- lib/pave/theme.rb
 - lib/pave/version.rb
 - lib/pave/virtual_host.rb
 - pave.gemspec
 - resources/deploy.sh
+- templates/themes/blank/css/styles.scss
+- templates/themes/blank/default.php
+- templates/themes/blank/description.txt
+- templates/themes/blank/elements/footer.php
+- templates/themes/blank/elements/header.php
+- templates/themes/blank/includes/view_helpers.php
+- templates/themes/blank/js/scripts.js
+- templates/themes/blank/thumbnail.png
+- templates/themes/blank/view.php
 - test/pave_test.rb
 homepage: https://github.com/jamonholmgren/pave
 licenses: