awestruct 0.5.4.beta1 → 0.5.4.rc

data/lib/awestruct/cli/deploy.rb

@@ -14,7 +14,7 @@ module Awestruct
         @site_config   = site_config
         @deploy_config = deploy_config
         @deploy_config['type'] ||= (is_github? ? :github_pages : :rsync)
-         $LOG.info "Deploying to #{deploy_type}" if $LOG.info?
+        $LOG.info "Deploying to #{deploy_type}" if $LOG.info?
       end
 
       def deploy_type
@@ -31,7 +31,7 @@ module Awestruct
         end
   
         deployer = deployer_class.new( site_config, deploy_config )
-        deployer.run(deploy_config)
+        deployer.run
       end
 
       private

data/lib/awestruct/cli/generate.rb

@@ -5,7 +5,7 @@ module Awestruct
   module CLI
     class Generate
 
-      def initialize(config, profile=nil, base_url=nil, default_base_url='http://localhost:4242', force=false)
+      def initialize(config, profile=nil, base_url=nil, default_base_url=Options::DEFAULT_BASE_URL, force=false)
         @profile          = profile
         @base_url         = base_url
         @default_base_url = default_base_url
@@ -15,9 +15,9 @@ module Awestruct
 
       def run()
         begin
-          base_url = @profile['base_url'] || @default_base_url
+          base_url = @base_url || @default_base_url
           $LOG.info "Generating site: #{base_url}" if $LOG.info?
-          @engine.run( @profile, @base_url, ( @profile ? @profile['base_url'] || @default_base_url : @default_base_url ), @force )
+          @engine.run( @profile, @base_url, @default_base_url, @force )
         rescue =>e
           $LOG.error e if $LOG.error?
           $LOG.error e.backtrace.join("\n") if $LOG.error?

data/lib/awestruct/cli/init.rb

@@ -22,7 +22,7 @@ module Awestruct
         mkdir('stylesheets')
       }
 
-      def initialize(opts = Awestruct::CLI::Options.new, framework = 'compass', scaffold = true)
+      def initialize(dir = Dir.pwd, framework = 'compass', scaffold = true)
         @dir = dir
         @framework = framework
         @scaffold = scaffold

data/lib/awestruct/cli/invoker.rb

@@ -1,13 +1,7 @@
-require 'awestruct/cli/options'
-
-require 'awestruct/cli/init'
-require 'awestruct/cli/generate'
-require 'awestruct/cli/auto'
-require 'awestruct/cli/server'
-require 'awestruct/logger'
-
 require 'pathname'
 require 'logger'
+require 'awestruct/logger'
+require 'awestruct/cli/options'
 
 module Awestruct
   module CLI
@@ -34,6 +28,12 @@ module Awestruct
         $LOG = Logger.new(Awestruct::AwestructLoggerMultiIO.new(@options.verbose, STDOUT, File.open('.awestruct/debug.log', 'w')))
         $LOG.level = @options.verbose ? Logger::DEBUG : Logger::INFO
         $LOG.formatter = Awestruct::AwestructLogFormatter.new
+
+        # these requires are deferred until after $LOG is set
+        require 'awestruct/cli/init'
+        require 'awestruct/cli/generate'
+        require 'awestruct/cli/auto'
+        require 'awestruct/cli/server'
       end
 
       def invoke!
@@ -100,7 +100,8 @@ module Awestruct
       end
 
       def invoke_generate()
-        @success = Awestruct::CLI::Generate.new( config, options.profile, options.base_url, 'http://localhost:4242', options.force ).run
+        base_url = profile['base_url'] || options.base_url
+        @success = Awestruct::CLI::Generate.new( config, options.profile, base_url, Options::DEFAULT_BASE_URL, options.force ).run
       end
 
       def invoke_deploy()
@@ -121,7 +122,7 @@ module Awestruct
       end
 
       def invoke_server()
-        run_in_thread( Awestruct::CLI::Server.new( './_site', options.bind_addr, options.port ) )
+        run_in_thread( Awestruct::CLI::Server.new( options.output_dir, options.bind_addr, options.port ) )
       end
 
 

data/lib/awestruct/cli/manifest.rb

@@ -29,7 +29,7 @@ class Compass::AppIntegration::StandAlone::Installer
 
         rake
 
-      then visit your site at: http://localhost:4242
+      then visit your site at: #{::Awestruct::CLI::Options::DEFAULT_BASE_URL}
     END
   end
 end

data/lib/awestruct/cli/options.rb

@@ -6,6 +6,16 @@ module Awestruct
   module CLI
 
     class Options
+      LOCAL_HOSTS = {
+        'localhost'  => 'localhost',
+        '0.0.0.0'    => 'localhost',
+        '127.0.0.1'  => 'localhost',
+        '::1'        => '[::1]',
+        'localhost6' => 'localhost6'
+      }
+      DEFAULT_BIND_ADDR = '0.0.0.0'
+      DEFAULT_PORT = 4242
+      DEFAULT_BASE_URL = %(http://#{LOCAL_HOSTS[DEFAULT_BIND_ADDR] || DEFAULT_BIND_ADDR}:#{DEFAULT_PORT})
 
       attr_accessor :generate
       attr_accessor :server
@@ -27,8 +37,8 @@ module Awestruct
       def initialize()
         @generate  = nil
         @server    = false
-        @port      = 4242
-        @bind_addr = '0.0.0.0'
+        @port      = DEFAULT_PORT
+        @bind_addr = DEFAULT_BIND_ADDR
         @auto      = false
         @force     = false
         @init      = false
@@ -71,10 +81,10 @@ module Awestruct
           opts.on( '-u', '--url URL', 'Set site.base_url' ) do |url|
             self.base_url = url
           end
-          opts.on( '-d', '--dev',     'Run site in development mode (--auto, --server, --port 4242 and --profile development)' ) do |url|
+          opts.on( '-d', '--dev',     "Run site in development mode (--auto, --server, --port #{DEFAULT_PORT} and --profile development)" ) do |url|
             self.server   = true
             self.auto     = true
-            self.port     = 4242
+            self.port     = DEFAULT_PORT
             self.profile  = 'development'
           end
 
@@ -90,10 +100,10 @@ module Awestruct
           opts.on( '-a', '--auto', 'Auto-generate when changes are noticed' ) do |a|
             self.auto = a
           end
-          opts.on( '-p', '--port PORT', Integer, 'Server port (default: 4242)' ) do |port|
+          opts.on( '-p', '--port PORT', Integer, "Server port (default: #{DEFAULT_PORT})" ) do |port|
             self.port = port
           end
-          opts.on( '-b', '--bind ADDR', 'Server address (default: 0.0.0.0)' ) do |bind_addr|
+          opts.on( '-b', '--bind ADDR', "Server address (default: #{DEFAULT_BIND_ADDR})" ) do |bind_addr|
             self.bind_addr = bind_addr
           end
           opts.on( '-g', '--[no-]generate', 'Generate site' ) do |g|

data/lib/awestruct/cli/server.rb

@@ -7,13 +7,16 @@ module Awestruct
     class Server
       attr_reader :server
 
-      def initialize(path, bind_addr='0.0.0.0', port=4242)
+      def initialize(path, bind_addr=Options::DEFAULT_BIND_ADDR, port=Options::DEFAULT_PORT)
         @path      = path
         @bind_addr = bind_addr
         @port      = port
       end
 
       def run
+        url = %(http://#{Options::LOCAL_HOSTS[@bind_addr] || @bind_addr}:#{@port})
+        msg = %(Starting preview server at #{url} (Press Ctrl-C to shutdown))
+        puts %(#{'*' * msg.length}\n#{msg}\n#{'*' * msg.length}\n)
         ::Rack::Server::start( :app => Awestruct::Rack::App.new( @path ),
                               :Port => @port,
                               :Host => @bind_addr

data/lib/awestruct/compatibility.rb

@@ -0,0 +1,5 @@
+unless File.respond_to?(:binread)
+  def File.binread(file)
+    File.open(file,"rb") { |f| f.read }
+  end
+end

data/lib/awestruct/config/default-site.yml

@@ -30,3 +30,10 @@ asciidoctor:
   :attributes:
     imagesdir: /images
     stylesdir: /stylesheets
+
+textile:
+  :no_span_caps: true
+
+profiles:
+  development:
+    show_drafts: true

data/lib/awestruct/deploy/base_deploy.rb

@@ -1,5 +1,6 @@
 require 'awestruct/deployers'
-Dir[ File.join( File.dirname(__FILE__), '..', 'scm' '*.rb' ) ].each do |f|
+require 'awestruct/compatibility'
+Dir[ File.join( File.dirname(__FILE__), '..', 'scm', '*.rb' ) ].each do |f|
   begin
     require f
   rescue LoadError => e
@@ -12,14 +13,27 @@ module Awestruct
   module Deploy
     class Base
       UNCOMMITTED_CHANGES = 'You have uncommitted changes in the working branch. Please commit or stash them.'
-      def run(deploy_config)
-        if deploy_config['uncommitted'] == true
+
+      def initialize(site_config, deploy_config)
+        # Add a single front slash at the end of output dir
+        @site_path = File.join( site_config.output_dir, '/' ).gsub(/^\w:\//, '/')
+        @gzip = deploy_config['gzip']
+        @source_dir = deploy_config['source_dir'] || site_config.dir
+        @ignore_uncommitted = deploy_config['uncommitted']
+        init_scm(deploy_config['scm'] || 'git')
+      end
+
+      def run
+        if @ignore_uncommitted == true
+          compress_site
           publish_site
         else
-          scm = deploy_config['scm'] || 'git'
-          #require "awestruct/scm/#{scm}"
-          scm_class = Object.const_get('Awestruct').const_get('Scm').const_get(scm.slice(0, 1).capitalize + scm.slice(1..-1))
-          scm_class.new.uncommitted_changes?(deploy_config['source_dir']) ? existing_changes() : publish_site()
+          if @scm.uncommitted_changes? @source_dir
+            existing_changes
+          else
+            compress_site
+            publish_site
+          end
         end
       end
 
@@ -30,6 +44,59 @@ module Awestruct
       def existing_changes
         $LOG.error UNCOMMITTED_CHANGES if $LOG.error?
       end
+
+      def compress_site
+        if @gzip
+          gzip_site @site_path
+        end
+      end
+
+      def gzip_site(site_path)
+        Dir.glob("#{site_path}/**/*") do |item|
+          next if item == '.' or item == '..'
+          ext = File.extname(item)
+          if !ext.empty?
+            ext_sym = ext[1..-1].to_sym
+            case ext_sym
+            when :css, :js, :html
+              require 'zlib'
+              if !is_gzipped item
+                gzip_file item
+              end
+            end
+          end
+        end
+      end
+
+      def gzip_file(filename)
+        $LOG.debug "Gzipping File #{filename}"
+        Zlib::GzipWriter.open("#{filename}.gz") do |gz|
+          gz.mtime = File.mtime(filename)
+          gz.orig_name = filename
+          gz.write File.binread(filename)
+        end
+        File.rename("#{filename}.gz", "#{filename}")
+      end
+
+      def is_gzipped(filename)
+        begin
+          File.open("#{filename}") do |f|
+            Zlib::GzipReader.new(f)
+            true
+          end
+        rescue
+          false
+        end
+      end
+
+      def init_scm type
+        begin
+          clazz = Object.const_get('Awestruct').const_get('Scm').const_get(type.capitalize)
+          @scm = clazz.new
+        rescue
+          $LOG.error( "Could not resolve class for scm type: #{type}" ) if $LOG.error?
+        end
+      end
     end
   end
 end

data/lib/awestruct/deploy/github_pages_deploy.rb

@@ -5,22 +5,35 @@ module Awestruct
   module Deploy
     class GitHubPagesDeploy < Base
       def initialize(site_config, deploy_config)
-        @site_path = site_config.output_dir
+        super
         @branch = deploy_config['branch'] || 'gh-pages'
         @repo = deploy_config['repository'] || 'origin'
       end
 
       def publish_site
-        current_branch = git.current_branch
-        # we may be on a detached branch,
-        # in which case use that commit as the branch
-        if current_branch == '(no branch)'
-          current_branch = git.revparse('HEAD')
+        tmp_branch = '__awestruct_deploy__'
+        detached_branch = nil
+
+        original_branch = git.current_branch
+
+        # detect a detached state
+        # values include (no branch), (detached from x), etc
+        if original_branch.start_with? '('
+          detached_branch = git.log(1).first.sha
+          git.branch(original_branch = tmp_branch).checkout
         end
+
+        # work in a branch, then revert to current branch
         git.branch(@branch).checkout
         add_and_commit_site @site_path
         git.push(@repo, @branch)
-        git.checkout(current_branch)
+
+        if detached_branch
+          git.checkout detached_branch
+          git.branch(original_branch).delete
+        else
+          git.checkout original_branch
+        end
       end
 
       private

data/lib/awestruct/deploy/rsync_deploy.rb

@@ -7,7 +7,7 @@ module Awestruct
     class RSyncDeploy < Base
 
       def initialize(site_config, deploy_config)
-        @site_path = File.join( site_config.output_dir, '/' ).gsub(/^\w:\//, '/')
+        super
         @host      = deploy_config['host']
         @path      = File.join( deploy_config['path'], '/' )
         @exclude   = deploy_config['exclude']

data/lib/awestruct/deploy/s3_deploy.rb

@@ -5,7 +5,7 @@ module Awestruct
   module Deploy
     class S3Deploy < Base
       def initialize( site_config, deploy_config )
-        @site_path = site_config.output_dir
+        super
         @bucket = deploy_config['bucket']
       end
 

data/lib/awestruct/engine.rb

@@ -51,9 +51,9 @@ module Awestruct
       $LOG.debug 'adjust_load_path' if $LOG.debug?
       adjust_load_path
       $LOG.debug 'load_default_site_yaml' if $LOG.debug?
-      load_default_site_yaml
-      $LOG.debug 'load_site_yaml -- profile' if $LOG.debug?
-      load_site_yaml(profile)
+      load_default_site_yaml( profile )
+      $LOG.debug 'load_user_site_yaml -- profile' if $LOG.debug?
+      load_user_site_yaml( profile )
       $LOG.debug 'set_base_url' if $LOG.debug?
       set_base_url( base_url, default_base_url )
       $LOG.debug 'load_yamls' if $LOG.debug?
@@ -105,35 +105,14 @@ module Awestruct
 
     end
 
-    def load_default_site_yaml
-      default_site_yaml = File.join( File.dirname( __FILE__ ), 'config', 'default-site.yml' )
-      if ( File.exist?( default_site_yaml ) )
-        data = YAML.load( File.read( default_site_yaml ) )
-        data.each do |k,v|
-          site.send( "#{k}=", v )
-        end if data
-      end
+    def load_default_site_yaml(profile = nil)
+      default_site_yaml_path = File.join( File.dirname( __FILE__ ), 'config', 'default-site.yml' )
+      load_site_yaml( default_site_yaml_path, profile )
     end
 
-    def load_site_yaml(profile)
-      site_yaml = File.join( site.config.config_dir, 'site.yml' )
-      if ( File.exist?( site_yaml ) )
-        data = YAML.load( File.read( site_yaml ) )
-        site.interpolate = true
-        profile_data = {}
-        data.each do |k,v|
-          if ( ( k == 'profiles' ) && ( ! profile.nil? ) )
-            profile_data = ( v[profile] || {} )
-          else
-            site.send( "#{k}=", merge_data( site.send( "#{k}" ), v ) )
-          end
-        end if data
-        site.profile = profile
-
-        profile_data.each do |k,v|
-          site.send( "#{k}=", merge_data( site.send( "#{k}" ), v ) )
-        end
-      end
+    def load_user_site_yaml(profile = nil)
+      site_yaml_path = File.join( site.config.config_dir, 'site.yml' )
+      load_site_yaml( site_yaml_path, profile )
     end
 
     def load_yamls
@@ -142,6 +121,31 @@ module Awestruct
       end
     end
 
+    def load_site_yaml(yaml_path, profile = nil)
+      if ( File.exist?( yaml_path ) )
+        data = YAML.load( File.read( yaml_path ) )
+        if ( profile )
+          site.interpolate = true
+          profile_data = {}
+          data.each do |k,v|
+            if ( ( k == 'profiles' ) && ( ! profile.nil? ) )
+              profile_data = ( v[profile] || {} )
+            else
+              site.send( "#{k}=", merge_data( site.send( "#{k}" ), v ) )
+            end
+          end if data
+          site.profile = profile
+          profile_data.each do |k,v|
+            site.send( "#{k}=", merge_data( site.send( "#{k}" ), v ) )
+          end
+        else
+          data.each do |k,v|
+            site.send( "#{k}=", v )
+          end if data
+        end
+      end
+    end
+
     def load_yaml(yaml_path)
       data = YAML.load( File.read( yaml_path ) )
       name = File.basename( yaml_path, '.yml' )