xfabricator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cb829b85a1c809946640551eea258db47b207d2
-  data.tar.gz: 95d19734a19e86962e8adf9c01b1f64886247fb2
+  metadata.gz: 645a21806994d33b4928c8ff917164bd7ee10e0f
+  data.tar.gz: 675a34495eba71982d963f6c0125d691852e747c
 SHA512:
-  metadata.gz: 6c65ba6fb729820365861262c81f2d8e8121ff9f86a18257d2257cb3934288d26a4b306bc442ca8331313b348ab7ca97f4739de1f476cb5d523425d1d55dedb6
-  data.tar.gz: b5f45876f1e1748fb73285c1f11b8438abcc8af8c63cbdbf64b502447b115ae8aed8e9ece1cb338ece1b5030cbf28e7b24514730342faddf8373d159be55cf06
+  metadata.gz: 98352f3416adb271fc9bd3d73379cdb018670e3072e6d7a1050cfb7e8108e18dddb7c129054bc0734c1599a3e74d5c41cc238a0cc964bcbfe605a022dfe765d8
+  data.tar.gz: 725e357afccdf7fa7e87495108454cc5c15e0b2d7baa09752319add13fd86aa60039147c1807275833e02b145e2140f6b11a50d1f7492d3575b5914f42554268

data/README.md

@@ -1,8 +1,8 @@
-# Xfabricator
+# xfabricator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xfabricator`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Generate files from mustache templates and add them directly to an xcode projects.
+* Generated files can be added to specific targets, groups and paths
+* Generated files can be added to groups automatically based on the path
 
 ## Installation
 
@@ -22,7 +22,69 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Project configuration
+
+This configuration file should be located somewhere in the root of your project directory.  When the `xfabricate` CLI
+tool is run it will scan up the folder hierarchy until it finds this file.
+
+**.xfabricate**
+```ruby
+FabricationConfig.create_config lambda { |config|
+    variables = {}
+    variables[:project_variable] = "value specific to the project"
+    variables[:some_interesting_value] = "another value specific to the project"
+
+    #Any project specific variables.  This can be omitted.
+    config[:variables] = variables
+
+    #The project file to add generated files to
+    config[:project_file] = "#{relative_path}/ExampleProj.xcodeproj"
+
+    #The location of template definitions and associated files; can be absolute or relative
+    config[:template_location] = "#{relative_path}/xftemplates"
+
+    #The target to associate any generated files when no specific target is specified
+    config[:default_target] = 'ExampleProj'
+}
+```
+
+### Template definitions
+
+The template definition file should be located in the template_location specified in the `.xfabricate` configuration file.
+A file named `Test.xftemplate` could be used for template fabrication using the following `xfabricate -t Test` anywhere
+inside the project.
+
+```ruby
+TemplateDefinition.create_definition lambda { |template_definition|
+    #Declare template files and generated file names
+    #Generated file names can include any project or template variable
+    template_files = [
+       TemplateFileDefinition.new("ExampleTemplate.h", '{{some_variable}}Widget.h'),
+       TemplateFileDefinition.new("ExampleTemplate.m", '{{some_variable}}Widget.m')
+    ]
+
+    template_definition[:template_files] = template_files
+
+    #declare variable names and appropriate prompts to request variable values
+    template_definition[:variable_prompts] = {
+       some_variable: 'some_variable value:',
+       a_variable_used_in_template: 'Please enter a value for the variable used in the template...'
+    }
+}
+```
+
+The template files are mustache templates with access to any variables in the project configuration or supplied at
+prompts defined in the template definition.
+
+### Command line tool
+
+```
+Usage: xfabricate [options]
+    -t, --template=template_name     specify template to fabricate
+    -a, --target=target_name         specify target to add created files
+    -g, --group=group_name           specify group to add created files
+    -p, --path=path_name             specify path to generate created files
+```
 
 ## Development
 
@@ -34,7 +96,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nicholascross/xfabricator.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/xfabricator/fabricator.rb

@@ -71,7 +71,15 @@ module Xfabricator
 
     def find_current_group
       project = @config.project
-      find_group_for_directory(project.main_group, @fabrication_path, project)
+      main_group = project.main_group
+
+      main_group_path = "#{project.path.parent.to_s}#{main_group.hierarchy_path}"
+      puts "#{main_group_path} == #{@fabrication_path.to_s}"
+      if main_group_path == @fabrication_path.to_s
+        return main_group
+      end
+
+      find_group_for_directory(main_group, @fabrication_path, project)
     end
 
     def find_group_for_directory(current_group, directory, project)

data/lib/xfabricator/version.rb

@@ -1,3 +1,3 @@
 module Xfabricator
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xfabricator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicholas Cross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler