pyro 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbd5afb69830d1640ab6d13d5078558c27311a3b
-  data.tar.gz: a944401a77fe94e767c5c8636e03cc2188b94bef
+  metadata.gz: 3605f85bb1db89f79e9093f4ff9eddd161adf9a8
+  data.tar.gz: 7a1fcbfa600aa8236315db0370fef4979d7877d0
 SHA512:
-  metadata.gz: c4bd3c62c7502fa6c39c75beb7ca04df27a530f71b7174f3de2b39942f03dacb1b5ae618b226fe785327f1961c18041dba77086dd14fb25e8e8248591e360c6f
-  data.tar.gz: 3efd9c17314c130e00e106091f56fd4afb683af843e9c9def9a19c234e207c6cea116ac5f27c21ca255a69910741ac51f28f72db241cdd28fa6928572cfd93ac
+  metadata.gz: bf23270974d0d3bcc194db597cfc33d267b90d6e30ef743b3e5e0f3bac0663f0eb73e85bafc2b2ee55506b2db9d8ffdbf84c661dcb2959b1416df550b815acc4
+  data.tar.gz: f578bf58b1a9af2217ec9c120fea1cb7b3b3e3b8a113f7e0ac8ffe40d086d9d977a963512bbf79635259bdb95c3d9957350cfa84c7eb197b2a72612eef2170c2

data/bin/pyro

@@ -3,22 +3,59 @@
 require 'thor'
 require 'pyro'
 
+# Public: CLI commands for Pyro.
+#
+# Examples
+#
+#   ~/Projects $ pyro new MyApp
 class PyroCLI < Thor
 
+  # Public: Create a new Pyro app.
+  #
+  # name - The name of the new app.
+  #
+  # Examples
+  #
+  #  ~/Projects $ pyro new MyApp
+  #
+  # Generates a new app into /MyApp.
   desc 'new NAME', 'Creats a new app'
   def new(name)
     FileUtils.cp_r("#{File.dirname(__FILE__)}/../templates/app", name)
   end
 
+  # Public: Create a new build of a Pyro app for production.
+  #
+  # * Production builds use prod_src/prod_dir, skip tests, and are minified.
+  #
+  # dir - The directory of the app to burn. Defaults to the current directory.
+  #
+  # Examples
+  #
+  #   ~/Projects/MyApp $ pyro burn
+  #   ~/Projects $ pyro burn MyApp # Burns the MyApp folder.
+  #
+  # Generates a production build of the app into /pkg/<timestamp>.
 	desc 'burn DIR', 'Builds an app for production'
   def burn(dir = '.')
     Pyro.burn('production', false, dir)
   end
 
+  # Public: Create a development build in /tmp and runs it on localhost:7976.
+  #
+  # * /tmp gets rebuilt on each refresh.
+  #
+  # --fast - Doesn't rebuild /assets.
+  # --test - Builds with the test helpers.
+  #
+  # Examples
+  #
+  #   ~/Projects/MyApp $ pyro serve
+  #
+  # Runs the development build on localhost:7976.
   desc 'serve', 'Starts a Pyro app on localhost,
                  --fast skips asset reloading,
                  --test includes tests'
-
   option :fast
   option :test
   def serve
@@ -35,6 +72,19 @@ class PyroCLI < Thor
     PyroServer.run!
   end
 
+  # Public: Run a production build on localhost:7976.
+  #
+  # build - The name (timestamp) of the build to run, from /pkg.
+  #
+  # * If no build is specified, the latest is used.
+  # * If no build exists, a new one is generated.
+  #
+  # Examples
+  #
+  #   ~/Projects/MyApp $ pyro stage
+  #   ~/Projects/MyApp $ pyro stage <timestamp>
+  #
+  # Runs the production build on localhost:7976.
   desc 'stage BUILD', 'Stages a Pyro build on localhost'
   def stage(build_num = false)
     if build_num
@@ -45,7 +95,7 @@ class PyroCLI < Thor
     end
 
     unless Dir.exists? build_dir
-      puts "That build doesn't exist. Try running 'pyro burn' to create a build."
+      puts "That build doesn't exist. Run 'pyro burn' to create a build."
       exit
     end
 
@@ -57,4 +107,9 @@ class PyroCLI < Thor
 
 end
 
+# Public: Start the PyroCLI.
+#
+# Examples
+#
+#   ~ $ pyro
 PyroCLI.start(ARGV)

data/lib/pyro.rb

@@ -1,9 +1,26 @@
 require 'fileutils'
 require 'pyro/assets'
 
+# Public: Main script for running Pyro.
+#
+# Examples
+#
+#   Pyro.burn('development', true)
 module Pyro
   include Pyro::Assets
 
+  # Public: Burn a build of an app.
+  #
+  # target      - 'development' or 'production' determines compression
+  #                and output directory.
+  # fast        - Boolean to run the server faster (skips rebuilding resources).
+  # working_dir - Path to the app.
+  #
+  # Examples
+  #
+  #   Pyro.burn('development', true)
+  #
+  # Generates a built app.
   def self.burn(target = 'production', fast = false, working_dir = '.')
     @target      = target
     @timestamp   = Time.now.strftime "%Y%m%d%H%M%S"

data/lib/pyro/asset.rb

@@ -3,42 +3,95 @@ require 'coffee-script'
 require 'fileutils'
 require 'sass'
 
+# Public: Define an Asset.
+#
+# Examples
+#
+#   Asset.new(file: "#{@working_dir}/#{args[:src]}",
+#        build_dir: @build_dir,
+#      working_dir: @working_dir,
+#      helper_args: args)
 module Pyro
   class Asset
     attr_accessor :file, :build_dir, :working_dir, :helper_args
 
+    # Public: Set args to attrs on new().
+    #
+    # Examples
+    #
+    #   Asset.new(file: "#{@working_dir}/#{args[:src]}",
+    #        build_dir: @build_dir,
+    #      working_dir: @working_dir,
+    #      helper_args: args)
+    #
+    # Returns an Asset instance.
     def initialize(args)
       args.each { |k, v| instance_variable_set("@#{k}", v) }
     end
 
+    # Public: Map File methods to an Asset.
+    #
+    # * Maybe Asset should inheret from File?
+    #
+    # Examples
+    #
+    #   @asset.mtime
+    #
+    # * See the File class for more info.
     def mtime
       File.mtime file
     end
-
     def basename
       File.basename file
     end
-
     def dirname
       File.dirname file
     end
-
     def extname
       File.extname file
     end
 
+    # Public: Strip the extension from the basename.
+    #
+    # Examples
+    #
+    #   @asset.name
+    #
+    # Retunrs a String of the basename without the extension.
+    #   ('my_file.rb' -> 'myfile')
     def name
       basename.sub(extname, '')
     end
 
+    # Public: Format the mtime as a timestamp String.
+    #
+    # Examples
+    #
+    #   @asset.timestamp
+    #
+    # Returns a String.
     def timestamp
       mtime.strftime "%Y%m%d%H%M%S"
     end
 
+    # Public: Find the relative target path of an Asset.
+    #
+    # Examples
+    #
+    #   @asset.relative_dir
+    #
+    # Returns a path as a String.
     def relative_dir
       dirname.sub("#{working_dir}/", '')
     end
 
+    # Public: Find the relative target file path of an Asset.
+    #
+    # Examples
+    #
+    #   @asset.relative_file
+    #
+    # Returns a filepath as a String.
     def relative_file
       if helper_args[:target]
         helper_args[:target]
@@ -47,6 +100,13 @@ module Pyro
       end
     end
 
+    # Public: Determine the target extension of an Asset.
+    #
+    # Examples
+    #
+    #   @asset.compiled_ext
+    #
+    # Returns a String.
     def compiled_ext
       case extname
       when '.coffee', '.hbs', '.handlebars'
@@ -58,6 +118,13 @@ module Pyro
       end
     end
 
+    # Public: Compile the contents of an Asset.
+    #
+    # Examples
+    #
+    #   @asset.contents
+    #
+    # Returns the compiled contents.
     def contents
       contents = File.read file
       case extname
@@ -72,6 +139,15 @@ module Pyro
       contents
     end
 
+    # Public: Find the name to use for a Handlebars template.
+    #
+    # * Use the name: arg in the template() helper to override the default.
+    #
+    # Examples
+    #
+    #   @asset.template_name
+    #
+    # Returns the relative template path and filename unless told otherwise.
     def template_name
       if helper_args[:name]
         helper_args[:name]
@@ -84,11 +160,25 @@ module Pyro
       end
     end
 
+    # Public: Generate a compiled Asset.
+    #
+    # Examples
+    #
+    #   @asset.generate_file
+    #
+    # Generates a compiled Asset file into a target file.
     def generate_file
       FileUtils.mkdir_p "#{build_dir}/#{relative_dir}"
       File.open("#{build_dir}/#{relative_file}", 'a+') { |f| f.write contents }
     end
 
+    # Public: Generate link to a generated Asset.
+    #
+    # Examples
+    #
+    #   @asset.generate_link
+    #
+    # Retunrs a <script> or <link> tag.
     def generate_link
       case compiled_ext
       when '.js'

data/lib/pyro/assets.rb

@@ -3,6 +3,11 @@ require 'jsmin'
 require 'sass'
 require 'pyro/asset'
 
+# Public: Manage Assets.
+#
+# Examples
+#
+#   Pyro::Assets.compress('./tmp/public')
 module Pyro
   module Assets
     def self.included(base)
@@ -11,16 +16,45 @@ module Pyro
 
     module ClassMethods
 
-      define_method(:script)     { |*args| build(args.first, 'js, coffee')      }
-      define_method(:stylesheet) { |*args| build(args.first, 'css, scss')       }
-      define_method(:template)   { |*args| build(args.first, 'hbs, handlebars') }
-
+      # Public: Helpers for index.erb.
+      #
+      # src      - Path to source file.
+      # dir      - Path to directory of source files.
+      # prod_src - Path to production version of source file.
+      # prod_dir - Path to directory of production versions of source files.
+      # target   - Path to output file (defaults to build path + source path).
+      # name     - String to name a Handlebars template.
+      #
+      # Examples
+      #
+      #   <%= script src: '/lib/app.coffee' %>
+      #
+      # Returns an asset tag (<script> or <link>).
+      def script(*args)
+        build(args.first, 'js, coffee')
+      end
+      def stylesheet(*args)
+        build(args.first, 'css, scss')
+      end
+      def template(*args)
+        build(args.first, 'hbs, handlebars')
+      end
       def test(*args)
         build(args.first, 'js, coffee, css, scss') if @target == 'test'
       end
 
       private
 
+      # Private: Find and compile assets.
+      #
+      # args    - Args.first from the helpers.
+      # src_ext - The source file extensions filter by.
+      #
+      # Examples
+      #
+      #   build(args.first, 'css, scss')
+      #
+      # Returns an asset tag (<script> or <link>).
       def build(args, src_ext)
         tags = ''
         find_assets(args, src_ext).each do |asset|
@@ -34,6 +68,16 @@ module Pyro
         tags
       end
 
+      # Private: Find assets.
+      #
+      # args - Args from build().
+      # exts - The source file extensions filter by.
+      #
+      # Examples
+      #
+      #   find_assets(args, src_ext)
+      #
+      # Returns an Array of Asset instances.
       def find_assets(args, exts)
         if @target == 'production'
           args[:src] = args[:prod_src] if args[:prod_src]
@@ -47,8 +91,8 @@ module Pyro
                        working_dir: @working_dir,
                        helper_args: args)
         elsif args[:dir]
-          Dir.glob("#{@working_dir}/#{args[:dir]}/**/*.{#{exts}}").each do |file|
-            assets << Asset.new(file: file,
+          Dir.glob("#{@working_dir}/#{args[:dir]}/**/*.{#{exts}}").each do |f|
+            assets << Asset.new(file: f,
                            build_dir: @build_dir,
                          working_dir: @working_dir,
                          helper_args: args)
@@ -57,6 +101,15 @@ module Pyro
         assets
       end
 
+      # Private: Compress all assets in a directory.
+      #
+      # dir - Path of directory to compress.
+      #
+      # Examples
+      #
+      #   Pyro::Assets.compress('./tmp/lib')
+      #
+      # Asset files are overwritten with their own compressed contents.
       def compress(dir)
         Dir.glob("#{dir}/**/*.js").each do |file|
           contents = File.read(file)

data/lib/pyro/server.rb

@@ -2,15 +2,21 @@ require 'pyro'
 require 'sinatra/base'
 require 'erb'
 
+# Public: Run a Pyro app on a Sinatra server.
+#
+# Examples
+#
+#   ~/MyApp $ pyro serve
 class PyroServer < Sinatra::Base
   include Pyro
 
-  set :fast_build,    false
+  set :fast_build,    false         # true to skip reloading resources.
   set :port,          7976
-  set :public_folder, './tmp'
-  set :staging,       false
-  set :target,        'development'
+  set :public_folder, './tmp'       # Override for staging builds.
+  set :staging,       false         # true to skip hot-rebuilding.
+  set :target,        'development' # 'test' to use test helpers.
 
+  # Public: Burn an app and response with the built index.html.
   get '/?' do
     unless settings.staging
       Pyro.burn(settings.target, settings.fast_build)

data/pyro.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "pyro"
-  gem.version       = "1.0.0.rc1"
+  gem.version       = "1.0.0.rc2"
   gem.authors       = "Jarrod Taylor"
   gem.email         = "jarrodtaylor@icloud.com"
   gem.homepage      = "https://github.com/jarrodtaylor/pyro"

data/templates/app/index.erb

@@ -6,6 +6,7 @@
   <%= stylesheet src: 'resources/stylesheets/normalize.css' %>
   <%= stylesheet src: 'resources/stylesheets/style.scss' %>
 
+  <%= test src: 'vendor/qunit/qunit.js' %>
   <%= test src: 'vendor/qunit/qunit.css' %>
 </head>
 <body>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pyro
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Jarrod Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: barber