app_stack 1.0.0 → 1.1.0

data/README.md

@@ -10,15 +10,17 @@ a stack of modules.
 Put a configuration file `.app_stack.yml` in your application
 directory, in format like:
 
-    stack: [module-1, module-2]
+    stack: 
+      - module-1
+      - module-2: [defaults, tests]
     stack_dir: '../stack-apps'
     tpl_ext: '.erb'
     verbose: 1
     export:
       - lib/**/*.rb
       - app/**/*.rb
-    include:
-      - spec/**/*.rb
+      - tests:
+          - spec/**/*.rb
     exclude:
       - lib/extra/*.rb
     attrs:
@@ -33,6 +35,27 @@ directory, in format like:
     files:
       README.md: __self
  
+
+`stack`
+: 设置导入的模块名，元素为字符串（只导入'default'组的文件）或Hash，
+: 为Hash时，key为模块名，值为文件组的数组（'all'代表全部）。
+
+`stack_dir`（默认为`../stack-apps`）
+: 模块程序所在位置。
+
+`export`（默认为空）
+: 可被拷贝至其他模块的文件pattern（为字符串时），或pattern的组
+: （像上述示例中的`tests`一样）。
+
+`exclude`（默认为空）
+: 导出到其它模块时，从`export`列表中除外的文件pattern。
+: 注意如果模块中定义了`.gitignore`文件，则其中的内容也会被加载至
+: `exclude`列表。
+
+`attrs`
+: 用于assign至`.erb`文件的属性值。在上面的例子中module2会继承
+: module1中设置的值。
+
 `files` field is auto-generated, you should not edit it manually.
 
 `export` defines files that should be copied when other modules include
@@ -47,7 +70,7 @@ Variables defined in `attrs` will be assigned into `.erb` files.
 
 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.
+be assigned into this file. 
 
 Variables in `attrs` will be merged in chain follows the app-stack.
 

data/lib/app_stack/version.rb

@@ -2,5 +2,5 @@
 
 # AppStack module
 module AppStack
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/app_stack.rb

@@ -26,8 +26,8 @@ module AppStack
     render_self!(@self_files)
 
     # rewrite configuration back to app-stack file
-    @config['files'] = @files
-    File.open(conf_file, 'wb') { |fh| fh.puts YAML.dump(@config) }
+    @origin_config['files'] = @files
+    File.open(conf_file, 'wb') { |fh| fh.puts YAML.dump(@origin_config) }
   end
 
   # convert directory names, load configuration from yaml file
@@ -35,6 +35,7 @@ module AppStack
   def load_configuration(conf_file)
     @conf_file = conf_file || CONF_FILE
     @config = YAML.load(File.read(@conf_file))
+    @origin_config = @config.dup
 
     @app_root = @config['app_root'] || File.dirname(@conf_file)
     @app_root = File.expand_path(@app_root)
@@ -42,17 +43,25 @@ module AppStack
     @stack_dir = File.expand_path(@app_root + '/' +
                       @stack_dir) if @stack_dir.match(/^\.\.?\//)
 
+    # default values
     @verbose = @config['verbose'] || 1
     @verbose = @verbose.to_i
 
     @config['tpl_ext'] ||= '.erb'
+    raise ArgumentError, 'ERROR: `include` key depriciated, ' +
+          'please update your yml file' if @config['include']
+    @config['include'] = []
+    @config['exclude'] ||= []
+    @config['export'] ||= [] # even export can be blank
+    @config['stack'] ||= []
+    @config['files'] ||= {}
 
     # attrs to assigned into template
     @attrs = {}
     # file list under the app_root
     @self_files = []
 
-    @files = @config['files'] || {}
+    @files = @config['files']
   end
 
   # for files already in the app root, register to no-copy list
@@ -91,13 +100,20 @@ module AppStack
   # copy from a stack of applications
   def merge_stacks!(stack)
     stack.each do |app|
-      app_dir = @stack_dir + '/' + app
+
+      app_dir, groups = '', ['default']
+      if app.is_a?(Hash)
+        app.each { |k, v| app_dir, groups = k, v }
+      else
+        app_dir = @stack_dir + '/' + app
+      end
+
       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))
 
       # loop over remote files
-      elist = export_list(app_dir)
+      elist = export_list(app_dir, groups)
       elist.each do |file|
         # skip .erb file as template
         next if file.match(/#{@config['tpl_ext']}$/) &&
@@ -149,8 +165,8 @@ module AppStack
     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)
+          fn = f.sub(/^#{dir}\//, '')
+          ilist << fn unless ilist.include?(fn)
         end
       end
     end
@@ -165,32 +181,46 @@ module AppStack
   end
 
   # find a list of file to copy based on export setting
-  def export_list(dir)
+  def export_list(dir, groups = ['default'])
     dir_conf = YAML.load(File.read(dir + '/' + File.basename(@conf_file)))
     dir_conf['export'] ||= []
+    dir_conf['exclude'] ||= []
 
     # 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 = []
+    group_patterns, flist = { 'default' => [] }, []
     # export list defined in stack app's configuration
     dir_conf['export'].each do |e|
-      Dir[dir + '/' + e].each { |f| flist << f.sub(/^#{dir}\/?/, '') }
+      if e.is_a?(Hash)
+        e.each { |k, v| group_patterns[k] = v }
+      else
+        group_patterns['default'] << e
+      end
     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}\/?/, '') }
+    group_patterns.each do |k, v|
+      raise "file for group #{k} is not a array." unless v.is_a?(Array)
+      next unless groups.include?(k) || groups.include?('all')
+      v.each do |e|
+        Dir[dir + '/' + e].each do |f|
+         fn = f.sub(/^#{dir}\/?/, '')
+         flist << fn unless flist.include?(fn)
+        end
+      end
     end
 
-    @config['exclude'].each do |exc|
-      Dir[dir + '/' + exc].each { |f| exc_list << f.sub(/^#{dir}\/?/, '') }
+    exc_list = []
+    dir_conf['exclude'].each do |exc|
+      Dir[dir + '/' + exc].each do |f|
+        fn = f.sub(/^#{dir}\/?/, '')
+        exc_list << fn unless exc_list.include?(fn)
+      end
     end
 
     # adjust by include/exclude and
-    flist + inc_list - gitignore_list(dir) - exc_list
+    flist - gitignore_list(dir) - exc_list
   end
 
   # copy file if newer
@@ -218,14 +248,18 @@ module AppStack
 
   # 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
-    'rendered'.bold.green
-    # end
+    done = 'keep'.white
+    unless newer?(target, f)
+      tilt = Tilt::ERBTemplate.new(f)
+      oh = File.open(target, 'wb')
+      oh.write tilt.render(OpenStruct.new(@attrs.deep_merge(@config['attrs'])))
+      oh.close
+
+      # update template timestamp
+      FileUtils.touch(f)
+      done = 'rendered'.bold.green
+    end
+    done
   end
 
   # use module variables, skip `new`

data/spec/{merge_stack_spec.rb → export_list_spec.rb}

@@ -35,9 +35,24 @@ describe AppStack do
       el.include?('lib/extra/excludes.rb').should be_false
     end
 
-    it 'include explicitly included files' do
-      el.include?('spec/spec_helper.rb').should be_true
-      el.include?('spec/support/api_test.rb').should be_true
+    # depreciated
+    # it 'include explicitly included files' do
+    #   el.include?('spec/spec_helper.rb').should be_true
+    #   el.include?('spec/support/api_test.rb').should be_true
+    # end
+
+    it 'can include grouped files' do
+      el.include?('spec/support/api_test.rb').should be_false
+      elist = AppStack.export_list('spec/fixtures/incexc', ['default', 'test'])
+      elist.include?('spec/support/api_test.rb').should be_true
+      elist.include?('spec/spec_helper.rb').should be_true
+    end
+
+    it 'can set to include all files' do
+      elist = AppStack.export_list('spec/fixtures/incexc', ['all'])
+      elist.include?('spec/support/api_test.rb').should be_true
+      elist.include?('spec/spec_helper.rb').should be_true
+      elist.include?('lib/mixin/otherlib.rb').should be_true
     end
   end
 

data/spec/fixtures/.app_stack.yml

@@ -6,8 +6,6 @@ export:
 - lib/**/*.rb
 - config/**/*
 - app/**/*.rb
-include:
-- spec/**/*.rb
 exclude:
 - lib/extra/*.rb
 attrs:
@@ -21,4 +19,3 @@ attrs:
     development:
       app_stack: ~> 0.0.8
 files:
-tpl_ext: .erb

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

@@ -5,8 +5,8 @@ verbose: 1
 export:
   - lib/**/*.rb
   - app/**/*.rb
-include:
-  - spec/**/*.rb
+  - test:
+      - spec/**/*
 exclude:
   - lib/extra/*.rb
 attrs:

data/spec/fixtures/incexc-config.yml

@@ -6,8 +6,6 @@ export:
   - lib/**/*.rb
   - Rakefile
   - Rakefile.erb
-include:
-  - spec/**/*.rb
 exclude:
   - lib/extra/*.rb
 attrs:

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

@@ -6,8 +6,6 @@ export:
 - lib/**/*.rb
 - config/**/*
 - app/**/*.rb
-include:
-- spec/**/*.rb
 exclude:
 - lib/extra/*.rb
 attrs:
@@ -31,4 +29,3 @@ files:
   lib/libonly1.rb: module-1
   lib/libonly2.rb: module-2
   Gemfile: module-2
-tpl_ext: .erb

data/spec/fixtures/sample_config.yml

@@ -5,8 +5,6 @@ verbose: 1
 export:
   - lib/**/*.rb
   - app/**/*.rb
-include:
-  - spec/**/*.rb
 exclude:
   - lib/extra/*.rb
 attrs:

data/spec/fixtures/stack_apps/module-2/.app_stack.yml

@@ -4,8 +4,6 @@ export:
   - config/**/*
   - app/**/*.rb
   - Gemfile
-include:
-  - spec/**/*.rb
 exclude:
   - lib/extra/*.rb
 attrs:

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: app_stack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Huang Wei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -92,6 +103,7 @@ files:
 - app_stack.gemspec
 - lib/app_stack.rb
 - lib/app_stack/version.rb
+- spec/export_list_spec.rb
 - spec/fixtures/.app_stack.yml
 - spec/fixtures/incexc-config.yml
 - spec/fixtures/incexc/.gitignore
@@ -119,36 +131,37 @@ files:
 - spec/fixtures/stack_apps/module-2/lib/libonly2.rb
 - spec/gitignore_list_spec.rb
 - spec/load_configuration_spec.rb
-- spec/merge_stack_spec.rb
 - spec/register_self_spec.rb
 - spec/spec_helper.rb
 - spec/stackup_spec.rb
 homepage: https://github.com/7lime/app_stack-gem
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 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.
 test_files:
+- spec/export_list_spec.rb
 - spec/fixtures/incexc/lib/anyway.rb
 - spec/fixtures/incexc/lib/extra/excludes.rb
 - spec/fixtures/incexc/lib/mixin/otherlib.rb
@@ -160,7 +173,6 @@ test_files:
 - spec/fixtures/stack_apps/module-2/lib/libonly2.rb
 - spec/gitignore_list_spec.rb
 - spec/load_configuration_spec.rb
-- spec/merge_stack_spec.rb
 - spec/register_self_spec.rb
 - spec/spec_helper.rb
 - spec/stackup_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmFmMzhjYjBiYmRmNjZkZjFjNGIxZWU5OThjZjJhOTRhNGJlZWUwNg==
-  data.tar.gz: !binary |-
-    MGRmMTNmYWY5NWI1ODY0ZWVmNDdmZDcxYmFmNTQyNzhkMzBlN2YwMw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YmRjYmU4N2MwZDIxYmUyMDRjM2FlMDRjNGIwN2RmZTA0YjhjZDU5MDgzYmFh
-    OTI3Yjk3NTFiM2FjNzRmMDI1YjM4YWU4ZWQ3OWM0NGZmNTMyMTg1OTMzYjk3
-    NWM4YTUwZGVhZDcyOTRlMTZmYWI3MTNjOGE5Mzk2MzEyYjQxN2Y=
-  data.tar.gz: !binary |-
-    ZjFkODQzOTVjZTA1ZDNjZWFjYjRjZWNjMjNkNTRmYmE0ZTVjNTQyZWQ5MDNi
-    YmQwODA1MTQwZGZkZGUxMGVmNWIzY2UyZDMyNWEwM2Y3YWNhZDE5ZDJjOTUy
-    NTY3ZTlhZDEyYzU4MDliN2U3NmUxYzNlZGRhYmFjMTM4YzVjMjU=