cakery 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 581bc71e2bc8d88cbebe64fb5278b4be32436e1e
-  data.tar.gz: 2a58a2df3fef396a0030863dc0697e5caf405056
+  metadata.gz: 920eb92b0f7768c0d57447338be4e816161705f7
+  data.tar.gz: 7735938903fb130741577a233d059a32b4054f3c
 SHA512:
-  metadata.gz: 28ba82fdd2cd990f583fec317e58732a0bed18af580a63c81bfff43b182803e1477b811bad53d3f9e3c4a0afeeba1f7d1dc722ba8e41b5e0acb7771494406daa
-  data.tar.gz: 843d171919add9d53ce542d0f3cc6eeb819ecfe36face3d6365069c515ced3456b21ecb2980ecd753d2057f1dbf2be770983fbee60e0c7133a37c72bcfd5e2b0
+  metadata.gz: dc687ce06115f77998d5d844febccdc3eb5a740d4945fe4a46301c1f991c11a45dfce137fc61097d32f6797abc7bb335c86eee052c5ba65ad86189b84ce66dcd
+  data.tar.gz: 04ccf69a6d5d9d5548c4b38a46e1cf8b02b62cf2d8bc5011fd39fcf23e4e18a4096c166c4aeb652978abd5ae2f43c95891bae3124a3f301ca93692547803dd82

data/README.md

@@ -5,31 +5,99 @@
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/sotownsend/cakery/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 [![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/sotownsend/cakery/blob/master/LICENSE)
 
-# What is this?
+##What is this?
 
-cakery helps you with file path issues; never worry again about relative paths with cakery's helper methods.
-Purpose built for our continuous integration & deployment infrastructure at Fittr®.
+Combine many files into one intelligently.  Cakery has a simple *DSL* that allows you to glob directories and pass strings to an **erb** file.  You can also add **macros** to a cakery pipeline. Think about it as a more generic version of [Sprockets](https://github.com/sstephenson/sprockets).
 
-## File, pwd, and project relative
-There are 3 relative ways of looking at a path in *cakery*.
-  * File Relative - A path relative to the current code file
-  * pwd Relative - A path relative to the current `pwd` pointer
-  * project Relative - A path relative to a project root (think rails)
+## Quick Start
 
-## Usage
-cakery's path helpers work by re-opening the string class to include a set of helper methods. Various
-other methods are put into the global object space.
+###Combine many js files in the `./spec` directory into one file
+In your ruby code:
+```ruby
+#Create a new recipe
+recipe = Cakery.new('test.js.erb') do |r|
+  #The << operator means to glob the directory into a string in @spec
+  r.spec << "./spec/*_spec.js"
+  
+  #The < operator means assignment
+  r.debug < true
+  r.foo < "bar"
+end
+
+#Build using the current directory
+cake = recipe.bake
+
+#Get the concatenated result of the build
+puts cake.src
+```
 
-## String Extension Methods
-  * `fr` (File relative) - Returns an absolute path from the relative string given assuming the current file is the origin.
-  * `pr(file)` (Project relative) - Returns an absolute path from the relative string given assuming the first ancestor folder containing `file` is the origin
+Create a test.js.erb with:
+```erb
+<%= @spec %>
+
+<!-- Announce whether we are in debug or release -->
+<% if @debug %>
+  console.log("Debug!");
+<% end %>
+  console.log("Release :(");
+<% end %>
+```
 
-## 
+------
 
-### Examples
+###Macros
+Macros receive a block of text and then do something with that text.  A *macro* is a subclass of **Cakery::Macro** that implements **def process(str)** and returns a **String**. You can also stack macros.
+
+In your ruby code:
 ```ruby
-#Open a file in the same directory as the first anscestor containing a .git file
+#Create a new recipe
+class MyMacro < Cakery::Macro
+  def process str
+    out = ""
+    str.split("\n").each do |line|
+      if line =~ /hello/
+        out += line.gsub(/hello/, "goodbye")
+      else
+        out += line
+      end
+      out += "\n"
+    end
+    out
+  end
+end
+
+recipe = Cakery.new('test.js.erb') do |r|
+  #The << operator means to glob the directory into a string in @spec
+  r.spec << MyMacro << "./spec/*_spec.js"
+  r.spec << MyMacro < "hello"
+  
+  #Additionally, you can stack macros. Macros always use the << operator intra macros
+  #The last operator may either be < or <<
+  r.spec << MyMacro << MyOtherMacro < "Hello"
+  r.spec << MyMacro << MyOtherMacro << "./spec/*_spec.js"
+  
+  #The < operator means assignment
+  r.debug < true
+  r.foo < "bar"
+end
+
+#Build using the current directory
+cake = recipe.bake
+
+#Get the concatenated result of the build
+puts cake.src
+```
+
+Create a test.js.erb with:
+```erb
+<%= @spec %>
 
+<!-- Announce whether we are in debug or release -->
+<% if @debug %>
+  console.log("Debug!");
+<% end %>
+  console.log("Release :(");
+<% end %>
 ```
 
 ## Requirements

data/Rakefile

@@ -1,17 +1,17 @@
 require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
 require "fileutils"
-require './lib/dur'
+require './lib/cakery'
 
 #Gem things
 #############################################################################
 #Upgrade version of gem
 def upgrade_version
-  versionf = './lib/dur/version.rb'
+  versionf = './lib/cakery/version.rb'
   require versionf
 
   #Upgrade version '0.0.1' => '0.0.2'
-  version = dur::VERSION
+  version = Cakery::VERSION
   new_version = version.split(".")
   new_version[2] = new_version[2].to_i + 1
   new_version = new_version.join(".")
@@ -30,9 +30,9 @@ task :push do
   `git push`
   `git tag #{version}`
   `git push origin #{version}`
-  `gem build dur.gemspec`
-  `gem push dur-#{version}.gem`
-  `rm dur-#{version}.gem`
+  `gem build cakery.gemspec`
+  `gem push cakery-#{version}.gem`
+  `rm cakery-#{version}.gem`
 end
 
 #############################################################################

data/cakery.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Cakery::VERSION
   spec.authors       = ["seo"]
   spec.email         = ["seotownsend@icloud.com"]
-  spec.summary       = "A boring javascript application framework"
-  spec.description   = "cakery is a cross-platform application framework system that exports javascript files"
+  spec.summary       = "Combine many files into one intelligently"
+  spec.description   = "Combine many files into one intelligently.  Cakery has a simple *DSL* that allows you to glob directories and pass strings to an **erb** file.  You can also add **macros** to a cakery pipeline. Think about it as a more generic version of [Sprockets](https://github.com/sstephenson/sprockets)."
   spec.homepage      = "https://github.com/sotownsend/cakery"
   spec.license       = "MIT"
 
@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry", "~> 0.10"
 end

data/lib/cakery.rb

@@ -1,3 +1,90 @@
+require 'cakery/macro'
+require 'erb'
+
 module Cakery
+  class Cakery
+    attr_accessor :src
+
+    #Create a new cakery (recipe) with an erb file
+    def initialize erb_path, &block
+      raise "You gave cakery the file: #{erb_path.inspect} but this wasn't a file" unless File.file?(erb_path)
+
+      #Create a new erb compiler
+      @erb_src = File.read(erb_path)
+      @erbc = ERB.new(@erb_src)
+
+      @block = block
+    end
+
+    def bake
+      ctx = CakeryERBContext.new
+      @block.call(ctx)
+      @src = @erbc.result(ctx.get_binding)
+    end
+  end
+
+  class CakeryERBContext
+    def initialize
+    end
+
+    def method_missing name, *args, &block
+      if name =~ /=/
+        name = ('@'+name.to_s.gsub(/=/, "")).to_sym
+        self.instance_variable_set(name, args.first)
+      else
+        return CakeERBContextTwoClauseHelper.new(self, name)
+      end
+    end
+
+    def get_binding
+      return binding
+    end
+  end
+
+  #Allow things like r.my_secret << './secret, this handles the '<<' part and
+  #is given 'my_secret' as a name
+  class CakeERBContextTwoClauseHelper
+    def initialize erb_context, name
+      @erb_context = erb_context
+      @name = name
+      @macros = []
+    end
+
+    def <<(e)
+      vname = ('@'+@name.to_s.gsub(/=/, "")).to_sym
+      out = ""
+
+      #Append all files or it's a macro class
+      if e.class == String
+        fpaths = Dir[e].select{|e| File.file?(e)}
+        fpaths.each do |fpath|
+          out << File.read(fpath)
+        end
+
+        #Run through each macro and run it in the reverse
+        #order that we put it in so that
+        #r.var << MyMacroA << MyMacroB << "./directory" will execute first MyMacroB and then MyMacroA
+        while macro = @macros.pop
+          out = macro.new.process(out)
+        end
+
+        @erb_context.instance_variable_set(vname, "") unless @erb_context.instance_variable_defined?(vname)
+        v = @erb_context.instance_variable_get(vname)
+        v += out
+        @erb_context.instance_variable_set(vname, v)
+
+      else
+        #Assume it's a macro, save it onto the stack
+        @macros << e
+
+        #Return self, recurse because there should be a string (or another macro)
+        #to the right of this one
+        return self
+      end
+    end
+  end
 
+  def self.new *params, &block
+    return Cakery.new(*params, &block)
+  end
 end

data/lib/cakery/macro.rb

@@ -0,0 +1,5 @@
+module Cakery
+  class Macro
+
+  end
+end

data/lib/cakery/version.rb

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

data/spec/assets/proj/test2/secret/secret.txt

@@ -0,0 +1 @@
+hello world

data/spec/assets/proj/test3/secret/deeper/secret.txt

@@ -0,0 +1 @@
+hello world

data/spec/assets/proj/test4/secret/secret.txt

@@ -0,0 +1,2 @@
+hello world 1
+goodbye world 2

data/spec/assets/proj/test5/secret1/secret.txt

@@ -0,0 +1 @@
+hello world

data/spec/assets/proj/test5/secret2/secret.txt

@@ -0,0 +1 @@
+goodbye world

data/spec/assets/test0.cakery

@@ -0,0 +1 @@
+test

data/spec/assets/test1.cakery

@@ -0,0 +1 @@
+<%= @secret %>

data/spec/assets/test2.cakery

@@ -0,0 +1 @@
+<%= @secret %>

data/spec/assets/test3.cakery

@@ -0,0 +1 @@
+<%= @secret %>

data/spec/assets/test4.cakery

@@ -0,0 +1 @@
+<%= @secret %>

data/spec/assets/test5.cakery

@@ -0,0 +1 @@
+<%= @secret %>

data/spec/bake_spec.rb

@@ -0,0 +1,155 @@
+require 'securerandom'
+require 'cakery'
+
+RSpec.describe "Baking" do
+  def cakery_path name
+    return File.join(File.dirname(__FILE__), "assets/#{name}.cakery")
+  end
+
+  #go into ./spec/assets/proj/$project_name and use
+  #it as a project folder
+  def cd_proj name
+    Dir.chdir File.join(File.dirname(__FILE__), "assets/proj/#{name}") do
+      yield
+    end
+  end
+
+  it "can run a no variable cakery file" do
+    cp = cakery_path "test0"
+    c = Cakery.new(cp) do |r|
+    end
+
+    c.bake
+    expect(c.src).to eq("test\n")
+  end
+
+  it "can use a text variable in the cakery file" do
+    cp = cakery_path "test1"
+    secret = SecureRandom.hex
+
+    c = Cakery.new(cp) do |r|
+      r.secret = secret
+    end
+
+    c.bake
+    expect(c.src).to eq("#{secret}\n")
+  end
+
+
+  it "can use a directory append" do
+    cp = cakery_path "test2"
+
+    c = Cakery.new(cp) do |r|
+      r.secret << './secret/*'
+    end
+
+    cd_proj "test2" do
+      c.bake
+    end
+    expect(c.src).to eq("hello world\n\n")
+  end
+
+  it "can use a directory append many" do
+    cp = cakery_path "test3"
+
+    c = Cakery.new(cp) do |r|
+      r.secret << './secret/**/*'
+    end
+
+    cd_proj "test3" do
+      c.bake
+    end
+    expect(c.src).to eq("hello world\n\n")
+  end
+
+  it "will not get depth if not requested" do
+    cp = cakery_path "test3"
+
+    c = Cakery.new(cp) do |r|
+      r.secret << './secret/*'
+    end
+
+    cd_proj "test3" do
+      c.bake
+    end
+    expect(c.src).to eq("\n")
+  end
+
+  it "supports macros" do
+    cp = cakery_path "test4"
+
+    class MyMacro < Cakery::Macro
+      def process str
+        out = ""
+        str.split("\n").each do |line|
+          if line =~ /hello/
+            out += line.gsub(/hello/, "goodbye")
+          else
+            out += line
+          end
+
+          out += "\n"
+        end
+        out
+      end
+    end
+
+    c = Cakery.new(cp) do |r|
+      r.secret << MyMacro << './secret/*'
+    end
+
+    cd_proj "test4" do
+      c.bake
+    end
+
+    #Started out with hello world 1, goodbye world 2 -> goodbye world 1, goodbye world 2
+    expect(c.src).to eq("goodbye world 1\ngoodbye world 2\n\n")
+  end
+
+  #it "supports stacked macros" do
+    #cp = cakery_path "test4"
+
+    #class MyMacro < Cakery::Macro
+      #def process str
+        #out = ""
+        #str.split("\n").each do |line|
+          #if line =~ /hello/
+            #out += line.gsub(/hello/, "goodbye")
+          #elsif line =~ /goodbye/
+            #out += line.gsub(/goodbye/, "fuck_you")
+          #else
+            #out += line
+          #end
+
+          #out += "\n"
+        #end
+        #out
+      #end
+    #end
+
+    #c = Cakery.new(cp) do |r|
+      #r.secret << MyMacro << MyMacro << './secret/*'
+    #end
+
+    #cd_proj "test4" do
+      #c.bake
+    #end
+
+    ##Started out with hello world 1, goodbye world 2 -> goodbye world 1, goodbye world 2
+    #expect(c.src).to eq("fuck_you world 1\nfuck_you world 2\n\n")
+  #end
+
+  #it "supports two dir sources to one variable" do
+    #cp = cakery_path "test5"
+
+    #c = Cakery.new(cp) do |r|
+      #r.secret << "./secret1/*"
+      #r.secret << "./secret2/*"
+    #end
+
+    #cd_proj "test5" do
+      #c.bake
+    #end
+    #expect(c.src).to eq("hello world\ngoodbye world\n\n")
+  #end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cakery
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: cakery is a cross-platform application framework system that exports
-  javascript files
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Combine many files into one intelligently.  Cakery has a simple *DSL*
+  that allows you to glob directories and pass strings to an **erb** file.  You can
+  also add **macros** to a cakery pipeline. Think about it as a more generic version
+  of [Sprockets](https://github.com/sstephenson/sprockets).
 email:
 - seotownsend@icloud.com
 executables: []
@@ -68,9 +84,21 @@ files:
 - Rakefile
 - cakery.gemspec
 - lib/cakery.rb
+- lib/cakery/macro.rb
 - lib/cakery/version.rb
 - logo.png
-- spec/test_spec.rb
+- spec/assets/proj/test2/secret/secret.txt
+- spec/assets/proj/test3/secret/deeper/secret.txt
+- spec/assets/proj/test4/secret/secret.txt
+- spec/assets/proj/test5/secret1/secret.txt
+- spec/assets/proj/test5/secret2/secret.txt
+- spec/assets/test0.cakery
+- spec/assets/test1.cakery
+- spec/assets/test2.cakery
+- spec/assets/test3.cakery
+- spec/assets/test4.cakery
+- spec/assets/test5.cakery
+- spec/bake_spec.rb
 homepage: https://github.com/sotownsend/cakery
 licenses:
 - MIT
@@ -94,6 +122,17 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: A boring javascript application framework
+summary: Combine many files into one intelligently
 test_files:
-- spec/test_spec.rb
+- spec/assets/proj/test2/secret/secret.txt
+- spec/assets/proj/test3/secret/deeper/secret.txt
+- spec/assets/proj/test4/secret/secret.txt
+- spec/assets/proj/test5/secret1/secret.txt
+- spec/assets/proj/test5/secret2/secret.txt
+- spec/assets/test0.cakery
+- spec/assets/test1.cakery
+- spec/assets/test2.cakery
+- spec/assets/test3.cakery
+- spec/assets/test4.cakery
+- spec/assets/test5.cakery
+- spec/bake_spec.rb

data/spec/test_spec.rb

@@ -1,5 +0,0 @@
-RSpec.describe "Hello" do
-  it "Works" do
-    puts "Hello"
-  end
-end