app_stack 0.0.7 → 0.0.8

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://ruby.taobao.org'
+
+gem 'tilt', '~> 1.4.1'
+gem 'term-ansicolor', '~> 1.2.2'
+gem 'activesupport', '~> 3.2.14'
+
+group :development, :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'simplecov', '~> 0.7.1'
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://ruby.taobao.org/
+  specs:
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    diff-lcs (1.2.4)
+    i18n (0.6.5)
+    multi_json (1.8.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    tilt (1.4.1)
+    tins (0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.2.14)
+  rspec (~> 2.14.1)
+  simplecov (~> 0.7.1)
+  term-ansicolor (~> 1.2.2)
+  tilt (~> 1.4.1)

data/README.md

@@ -1,46 +1,53 @@
-% AppStack: Merge Source Code from A Stack of App Modules
-% Huang Wei <huangw@7lime.com>
-% 3013-08-26
+# Merge Source Code from Directories in Chain
 
 ## Concept
 
-A configuration file `.app-stack.yml` in you app-root, in format like:
+Build your application by copy source files from
+a stack of modules.
 
-    stack: [base-module auth-module ...]
-    app_dir: '../stack-apps'
-    tpl_ext: '.sample.erb'
+## Synposis
+
+Put a configuration file `.app_stack.yml` in your application
+directory, in format like:
+
+    stack: [module-1, module-2]
+    stack_dir: '../stack-apps'
+    tpl_ext: '.erb'
     verbose: 1
-    file_patterns:
-      spec/**/*.rb
-      lib/**/*.rb
-      **/*.line_addon
-      **/*.erb
+    export:
+      - lib/**/*.rb
+      - app/**/*.rb
+    include:
+      - spec/**/*.rb
+    exclude:
+      - lib/extra/*.rb
     attrs:
-      dababase_name: 'nameofdatabase'
+      application_name: App Name
+      application_code: app_code
+      database_password: the very secret
+      gems:
+        default:
+          - rspec: '~> 2.0.0'
+          - ...
+        development:
     files:
-      README.md << __self
-      app/controllers/home_controller.rb << base-module
+      README.md: __self
+ 
+`files` field is auto-generated, you should not edit it manually.
 
-And in `Rakefile` add:
+`export` defines files that should be copied when other modules include
+the current module. Besides `export`, the acquire module can use `include`
+and `exclude` adjust files that imports from other modules.
 
-    require 'app_stack'
+Variables defined in `attrs` will be assigned into `.erb` files.
 
-    namespace :stack do
-      task :update do
-        AppStack.run!('.app-stack.yml')
-      end
-    end
+`gems` need a support from `Gemfile.erb`.
 
-Run `rack stack:up` will copy files according to the setting from yaml file,
-and any new files that in you app stack but not in the current directory.
+## Templates
 
-## Template and Addition
+If you have both a `config.yml` and a `config.yml.erb` file, when export,
+the `config.yml.erb` will be used instead of `config.yml`, and `attrs` will
+be assigned into this file.
 
-If you have a file end with `.sample.erb`, for example `config.sample.erb` 
-in your stack besides `config`, this file will be used as a erb template, and
-the output with combines with `attrs` set in your local yaml file. Those value
-will inherited follow the stacks (from v0.0.2).
+Variables in `attrs` will be merged in chain follows the app-stack.
 
-If you have a file name end with `.line_addon`, like `Gemfile.line_addon`,
-the contents of this file will add to local `Gemefile` line by line unless
-the line is already exists (from v0.0.3).

data/app_stack.gemspec

@@ -6,14 +6,15 @@ Gem::Specification.new 'app_stack', AppStack::VERSION do |s|
   s.summary           = 'Use as a rake task, define a stack of modules and app-stack will merge files from those stack-apps to the local application directory.'
   s.authors           = ['Huang Wei']
   s.email             = 'huangw@7lime.com'
-  s.homepage          = 'https://github.com/7lime/app-stack-gem'
-  s.files             = `git ls-files`.split("\n") - %w[.gitignore Rakefile]
+  s.homepage          = 'https://github.com/7lime/app_stack-gem'
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore .rspec Rakefile]
   s.license           = 'MIT'
   s.test_files        = Dir.glob('{spec,test}/**/*.rb')
 
-  s.add_dependency 'tilt'
-  s.add_dependency 'term-ansicolor'
-  s.add_development_dependency 'rspec', '~> 2.5'
-  s.add_development_dependency 'simplecov', '~> 2.5'
+  s.add_dependency 'tilt', '~> 1.4.1'
+  s.add_dependency 'term-ansicolor', '~> 1.2.2'
+  s.add_dependency 'activesupport', '~> 3.2.14'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'simplecov', '~> 0.7.1'
 end
 

data/lib/app_stack/version.rb

@@ -2,5 +2,5 @@
 
 # AppStack module
 module AppStack
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/app_stack.rb

@@ -5,6 +5,7 @@ require 'find'
 require 'fileutils'
 require 'ostruct'
 require 'tilt/erb'
+require 'active_support/core_ext/hash/deep_merge'
 
 require 'term/ansicolor'
 # mixin String class for term-color methods
@@ -12,121 +13,183 @@ class String; include Term::ANSIColor end
 
 ## A namespace for app-stack based modules
 module AppStack
+  CONF_FILE = '.app_stack.yml'
 
-  CONF_FILE = '.app-stack.yml'
+  # public entry ponit, receive a configuration filename,
+  # copy source files on to the directory contains the
+  # configuration file.
+  def stackup!(conf_file)
+    load_configuration(conf_file)
 
-  # public entry ponit, receive a configuration filename
-  def run!(file = '.app-stack.yml')
-    # load configuration
-    @config = YAML.load(File.read(file))
-    @attr = {}
-    # assign default values:
-    @app_root = File.expand_path(File.dirname(file)) unless @config['app_root']
-    @stack_apps_dir = @config['stack_apps_dir']
-    # convert relative path:
-    @stack_apps_dir = @app_root + '/' +
-                     @stack_apps_dir if @stack_apps_dir.match(/^\.\.?\//)
-
-    @files = @config['files'] || {}
-    register_own_files!
-    # loop over each stack application
-    @config['stack'].each { |stack_app| do_copy_stack!(stack_app) }
+    register_self!(@app_root)
+    merge_stacks!(@config['stack'])
+    render_self!(@self_files)
 
     # rewrite configuration back to app-stack file
     @config['files'] = @files
-    File.open(file, 'wb') { |fh| fh.puts YAML.dump(@config) }
+    File.open(conf_file, 'wb') { |fh| fh.puts YAML.dump(@config) }
+  end
+
+  # convert directory names, load configuration from yaml file
+  # rubocop:disable MethodLength
+  def load_configuration(conf_file)
+    @conf_file = conf_file || CONF_FILE
+    @config = YAML.load(File.read(@conf_file))
+
+    @app_root = @config['app_root'] || File.dirname(@conf_file)
+    @app_root = File.expand_path(@app_root)
+    @stack_dir = @config['stack_dir'] || '../stack_apps'
+    @stack_dir = File.expand_path(@app_root + '/' +
+                      @stack_dir) if @stack_dir.match(/^\.\.?\//)
+
+    @verbose = @config['verbose'] || 1
+    @verbose = @verbose.to_i
+
+    @config['tpl_ext'] ||= '.erb'
+
+    # attrs to assigned into template
+    @attrs = {}
+    # file list under the app_root
+    @self_files = []
+
+    @files = @config['files'] || {}
   end
 
   # for files already in the app root, register to no-copy list
-  def register_own_files!
-    @config['file_patterns'].each do |pt|
-      Dir[@app_root + '/' + pt].each do |f|
-        next if f == @app_root
-        basename = f.sub(/^#{@app_root}\//, '')
-        if @files[basename]
-          carp "From #{'self'.blue.bold} #{basename.bold} ",
-               'keep'.white if @files[basename] == '__self'
-        else
-          carp "From #{'self'.blue.bold} #{basename.bold}",
-               'registed'.green.bold
-          @files[basename] = '__self'
-        end
+  def register_self!(dir)
+    Find.find(dir).each do |f|
+      next if f == dir
+      basename = f.sub(/^#{dir}\//, '')
+      next if basename.match(/^.git$/)
+      next if basename.match(/^.git\W/)
+      next if gitignore_list(dir).include?(basename)
+
+      if @files[basename]
+        carp "From #{'self'.blue.bold} #{basename.bold} ",
+             'keep'.white, 2 if @files[basename] == '__self'
+      else
+        carp "From #{'self'.blue.bold} #{basename.bold}",
+             'registed'.green.bold, 1
+        @files[basename] = '__self'
       end
+
+      @self_files << f unless @self_files.include?(f)
     end
   end
 
-  # copy files for each included file
-  def do_copy_stack!(stack_app)
-    raise 'invalid app name "__self"' if stack_app == '__self'
-    stack_app_dir = File.expand_path(@stack_apps_dir + '/' + stack_app)
-
-    # merge attr setting
-    if File.exists?(stack_app_dir + '/' + CONF_FILE)
-      stack_conf = YAML.load(File.read(stack_app_dir + '/' + CONF_FILE))
-      @attr.merge! stack_conf['attrs'] if stack_conf['attrs'] &&
-                                      stack_conf['attrs'].is_a?(Hash)
+  # render file in app-root
+  def render_self!(files)
+    files.each do |f|
+      if File.exists?(f + @config['tpl_ext'])
+        basename = f.sub(/^#{@app_root}\//, '')
+        carp "From #{'self'.blue.bold} render #{basename.bold}",
+             render_file!(f + @config['tpl_ext'], f), 1
+      end
     end
+  end
 
-    # for each included files
-    @config['file_patterns'].each do |pt|
-      Dir[stack_app_dir + '/' + pt].each do |f|
-        basename = f.sub(/^#{stack_app_dir}\//, '')
-        # trivial ignore the stack directory itself:
-        next if f == stack_app_dir
-        if (@files[basename].nil? or @files[basename] == stack_app)
-          @files[basename] = stack_app unless @files[basename] # register
-          done = copy_file!(f, File.expand_path(@app_root + '/' + basename))
-          carp "From #{stack_app.blue.bold} #{basename.bold}", done
-        else
-          carp "From #{stack_app.blue.bold} #{basename.bold}",
-               'skip, use '.white + @files[basename]
+  # copy from a stack of applications
+  def merge_stacks!(stack)
+    stack.each do |app|
+      app_dir = @stack_dir + '/' + app
+      raise "no directory found for #{app}" unless File.directory?(app_dir)
+      raise "no configuration found for #{app}" unless
+               File.exists?(app_dir + '/' + File.basename(@conf_file))
+      carp "Merge #{app.bold.blue}"
+
+      # loop over remote files
+      elist = export_list(app_dir)
+      elist.each do |file|
+        # skip .erb file as template
+        next if file.match(/#{@config['tpl_ext']}$/) &&
+                elist.include?(file.sub(/#{@config['tpl_ext']}$/, ''))
+        # find the absolute path for source and target file for copy
+        src_f = File.expand_path(app_dir + '/' + file)
+        tgt_f = File.expand_path(@app_root + '/' + file)
+
+        if @files[file].nil? || @files[file] == app # yes, copy it
+          @files[file] = app unless @files[file]
+
+          carp "From #{app.blue.bold} copy #{file.bold}",
+               copy_file!(src_f, tgt_f),
+               1 unless File.exists?(src_f + @config['tpl_ext'])
+
+          # register the copied file to app-root file list
+          @self_files << file unless @self_files.include?(file)
+        else # don't handle it
+          carp "From #{app.blue.bold} #{file.bold}",
+               'skip, use '.white + @files[file], 2
         end
+
+        carp "From #{app.blue.bold} render #{file.bold}",
+             render_file!(src_f + @config['tpl_ext'], tgt_f),
+             1 if File.exists?(src_f + @config['tpl_ext'])
       end
     end
+  end
 
-    # for templates and addons
-    Find.find(stack_app_dir).each do |f|
-      basename = f.sub(/^#{stack_app_dir}\//, '')
+  # print debug / information message to console based on verbose level
+  def carp(job, state = 'done'.green, v = 1)
+    return if @verbose < v
+    dots = 70 - job.size
+    job += ' ' + '.' * dots if dots > 0
+    puts job + ' ' + state
+  end
 
-      if basename.gsub!(/#{@config['tpl_ext']}$/, '')
-        target = File.expand_path(@app_root + '/' + basename)
-        # next unless File.exists?(target)
-        done = 'keep'.white
-        if newer?(f, target)
-          tilt = Tilt::ERBTemplate.new(f)
-          oh = File.open(target, 'wb')
-          oh.write tilt.render(OpenStruct.new(@attr.merge(@config['attrs'])))
-          oh.close
-          done = 'rendered'.bold.green
+  # fetch (and cache) git ignore file lists for a specific directory
+  def gitignore_list(dir)
+    @gitignore_list ||= {}
+    @gitignore_list[dir] ||= []
+
+    ilist = []
+    if File.exists?(dir + '/.gitignore')
+      File.read(dir + '/.gitignore').split("\n").each do |line|
+        Dir[dir + '/' + line].each do |f|
+          f.sub!(/^#{dir}\//, '')
+          ilist << f unless ilist.include?(f)
         end
-        carp "From #{stack_app.blue.bold} render #{basename.bold}", done
-      elsif basename.gsub!(/#{@config['addon_ext']}$/, '')
-        target = File.expand_path(@app_root + '/' + basename)
-        if File.exists?(target)
-          done = do_addon!(f, target)
-        end
-        done ||= 'keep'.white
-        carp "From #{stack_app.blue.bold} addon #{basename.bold}", done
       end
     end
+    @gitignore_list[dir] = ilist
   end
 
+  # if f1 newer than f2, or f2 not exits but f1 does.
   def newer?(f1, f2)
     return false unless File.exists?(f1)
     return true unless File.exists?(f2)
     File.mtime(f1) > File.mtime(f2)
   end
 
-  def do_addon!(addon_file, target)
-    add_lines = File.read(addon_file).split("\n")
-    add_lines -= File.read(target).split("\n")
-    afh = File.open(target, 'a')
-    add_lines.each { |line| afh.puts line }
-    afh.close
-    lines = add_lines.size
-    done = "add #{lines} lines".bold.green if lines > 0
+  # find a list of file to copy based on export setting
+  def export_list(dir)
+    dir_conf = YAML.load(File.read(dir + '/' + File.basename(@conf_file)))
+    dir_conf['export'] ||= []
+
+    # update attr list for assign to template files
+    @attrs.deep_merge! dir_conf['attrs'] if dir_conf['attrs'] &&
+                                           dir_conf['attrs'].is_a?(Hash)
+
+    flist = []
+    # export list defined in stack app's configuration
+    dir_conf['export'].each do |e|
+      Dir[dir + '/' + e].each { |f| flist << f.sub(/^#{dir}\/?/, '') }
+    end
+
+    # collect include/exclude list from configuration of app-root
+    inc_list, exc_list = [], []
+    @config['include'].each do |inc|
+      Dir[dir + '/' + inc].each { |f| inc_list << f.sub(/^#{dir}\/?/, '') }
+    end
+
+    @config['exclude'].each do |exc|
+      Dir[dir + '/' + exc].each { |f| exc_list << f.sub(/^#{dir}\/?/, '') }
+    end
+
+    # adjust by include/exclude and
+    flist + inc_list - gitignore_list(dir) - exc_list
   end
 
+  # copy file if newer
   def copy_file!(f, target)
     # directory?
     if File.directory?(f)
@@ -138,6 +201,8 @@ module AppStack
       end
     else
       if newer?(f, target)
+        target_dir = File.dirname(target)
+        FileUtils.mkdir_p target_dir unless File.directory?(target_dir)
         FileUtils.copy f, target
         done = 'copied'.bold.green
       else
@@ -147,12 +212,20 @@ module AppStack
     done
   end
 
-  def carp(job, state = 'done'.green)
-    return unless @config['verbose'] && @config['verbose'] > 0
-    dots = 70 - job.size
-    dots = 0 if dots < 0
-    puts job + ' ' + '.' * dots + ' ' + state
+  # render from erb if newer
+  def render_file!(f, target)
+    done = 'keep'.white
+    if newer?(f, target)
+      tilt = Tilt::ERBTemplate.new(f)
+      oh = File.open(target, 'wb')
+      oh.write tilt.render(OpenStruct.new(@attrs.deep_merge(@config['attrs'])))
+      oh.close
+      done = 'rendered'.bold.green
+    end
+    done
   end
 
+  # use module variables, skip `new`
+  # rubocop:disable ModuleFunction
   extend self
 end

data/spec/fixtures/.app_stack.yml

@@ -0,0 +1,24 @@
+---
+stack:
+- module-1
+- module-2
+export:
+- lib/**/*.rb
+- config/**/*
+- app/**/*.rb
+include:
+- spec/**/*.rb
+exclude:
+- lib/extra/*.rb
+attrs:
+  application_name: My App Name
+  application_code: my_app_code
+  database_password: the very secret
+  gems:
+    default:
+      rspec: ~> 2.0.0
+      mongoid: ''
+    development:
+      app_stack: ~> 0.0.8
+files:
+tpl_ext: .erb

data/spec/fixtures/incexc/.gitignore

@@ -0,0 +1,27 @@
+.DS_Store
+.bundle
+logs/*.log
+logs/**/*.log
+log/*.log
+log/**/*.log
+tmp/**/*
+vendor/gems/*
+!vendor/gems/cache/
+.sass-cache/*
+public/assets/*
+*.bak
+tmp/*
+*.swp
+*~
+~*
+Thumbs.db
+*/Thumbs.db
+.idea/*
+db/*.db
+db/*.sqlite*
+.yardoc/*
+.yardoc/**/*
+docs/*
+docs/**/*
+.dev_flow
+*.gem

data/spec/fixtures/incexc/incexc-config.yml

@@ -0,0 +1,24 @@
+stack: [incexc]
+stack_dir: '.'
+tpl_ext: '.erb'
+verbose: 1
+export:
+  - lib/**/*.rb
+  - app/**/*.rb
+include:
+  - spec/**/*.rb
+exclude:
+  - lib/extra/*.rb
+attrs:
+  application_name: App Name
+  application_code: app_code
+  database_password: the very secret
+  gems:
+    default:
+      - rspec: '~> 2.0.0'
+      - mongoid: ''
+    development:
+files:
+  README.md: '__self'
+
+

data/spec/fixtures/incexc/lib/anyway.rb

@@ -0,0 +1 @@
+# encoding: utf-8

data/spec/fixtures/incexc/lib/extra/excludes.rb

@@ -0,0 +1 @@
+# encoding: utf-8

data/spec/fixtures/incexc/lib/mixin/otherlib.rb

@@ -0,0 +1 @@
+# encoding: utf-8

data/spec/fixtures/incexc/spec/spec_helper.rb

@@ -0,0 +1 @@
+# encoding: utf-8

data/spec/fixtures/incexc/spec/support/api_test.rb

@@ -0,0 +1 @@
+# encoding: utf-8

data/spec/fixtures/incexc-config.yml

@@ -0,0 +1,25 @@
+stack: [incexc]
+stack_dir: '.'
+tpl_ext: '.erb'
+verbose: 1
+export:
+  - lib/**/*.rb
+  - Rakefile
+  - Rakefile.erb
+include:
+  - spec/**/*.rb
+exclude:
+  - lib/extra/*.rb
+attrs:
+  application_name: App Name
+  application_code: app_code
+  database_password: the very secret
+  gems:
+    default:
+      - rspec: '~> 2.0.0'
+      - mongoid: ''
+    development:
+files:
+  README.md: '__self'
+
+

data/spec/fixtures/my_app/.app_stack.yml

@@ -0,0 +1,34 @@
+---
+stack:
+- module-1
+- module-2
+export:
+- lib/**/*.rb
+- config/**/*
+- app/**/*.rb
+include:
+- spec/**/*.rb
+exclude:
+- lib/extra/*.rb
+attrs:
+  application_name: My App Name
+  application_code: my_app_code
+  database_password: the very secret
+  gems:
+    default:
+      rspec: ~> 2.0.0
+      mongoid: ''
+    development:
+      app_stack: ~> 0.0.8
+files:
+  .app_stack.yml: __self
+  .gitignore: __self
+  Gemfile: __self
+  config: __self
+  config/self_render.conf: __self
+  config/self_render.conf.erb: __self
+  lib: __self
+  lib/auth_util.rb: __self
+  lib/libonly1.rb: module-1
+  lib/libonly2.rb: module-2
+tpl_ext: .erb

data/spec/fixtures/my_app/.gitignore

@@ -0,0 +1,27 @@
+.DS_Store
+.bundle
+logs/*.log
+logs/**/*.log
+log/*.log
+log/**/*.log
+tmp/**/*
+vendor/gems/*
+!vendor/gems/cache/
+.sass-cache/*
+public/assets/*
+*.bak
+tmp/*
+*.swp
+*~
+~*
+Thumbs.db
+*/Thumbs.db
+.idea/*
+db/*.db
+db/*.sqlite*
+.yardoc/*
+.yardoc/**/*
+docs/*
+docs/**/*
+.dev_flow
+*.gem

data/spec/fixtures/my_app/config/self_render.conf.erb

@@ -0,0 +1 @@
+self config for <%= application_code %>

data/spec/fixtures/my_app/lib/auth_util.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+def auth_util
+  'auth_util from module 1'
+end