enoki 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 421193dfba17a3a10ac4ed8e56bd17db8b62028f
-  data.tar.gz: 1d6939b29abfade2c748f85568ff0d9458331cc0
+  metadata.gz: 5b25b6f2f7ad6bcf55593ec13a521539ca4d2990
+  data.tar.gz: 18d52ddd228e5a60aa12795531093099b707eaee
 SHA512:
-  metadata.gz: bbeed8a9a88aa43f0008ee05502a2fb7b1c3daa6dedc11aad69c8a83bcd1f6d4a39e0a70bc521996b95b25c38ff817a74245366d8fa6454e70b1e42137f8d2ae
-  data.tar.gz: 51e0140f87338c6cf541682af93a5167c48531e0e304a058d2b54c2ee13202891690cb2daf561b76cb1bf85ebc20311d1c6561ad34b5cb2a55b840cc18daa329
+  metadata.gz: 6061c4646350e534be0b99f69992aef9ba5808ad21023d930a865fb9bff6e4bbff5d7bcb4e66b2aa0676d935e973a7d94a792858e9cd681535d9789bff46e20d
+  data.tar.gz: 1a8f4baf6eaa558c2025c4bc276cd82749d60255ccf58b34ce3ed7ca5e7b3cf124beb2a039347fb56bcedfc18aa5a25ab9ef2622cfc4fbfe4c070cf6f2dc5541

data/README.md

@@ -1,6 +1,7 @@
 # Enoki
 
 Code generator for Xcode project.
+You can manage multiple user-defined file template set in your project.
 
 ## Installation
 
@@ -10,13 +11,80 @@ $ gem install enoki
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setup
 
-## Development
+Run `enoki init` in your project root directory, then created `.enoki.yml` file with some questions.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Create template set
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Create template set directory in your template directory (default: ./templates) and organize template files. The template file has extension `.tt`.
+
+For example: https://github.com/slightair/enoki/tree/master/examples/Enoki%20Example/templates
+
+```
+templates
+├── Test
+│   └── Enoki\ Example
+│       ├── ViewController
+│       │   └── __name__ViewController.swift.tt
+│       └── ViewModel
+│           └── __name__ViewModel.swift.tt
+└── VIPER
+    └── Enoki\ Example
+        └── Modules
+            └── __name__
+                └── __name__ViewController.swift.tt
+```
+
+This example case has 2 template set,  `Test` and `VIPER`.
+
+### Generate source code
+
+Next, run `enoki generate Test Hello` and generated following files.
+
+```
+      create  Enoki Example/ViewController/HelloViewController.swift
+      create  Enoki Example/ViewModel/HelloViewModel.swift
+```
+
+Then added 2 files to your Xcode project and setup project groups that correspond to template set directory tree. 
+
+![](./assets/project_file_tree.png)
+
+### File name rule
+
+If you use `__name__` in file or directory name of template, replace to capitalized name argument in your command.
+
+For example, generate `Modules/Hello/HelloViewController.swift` from template file `Modules/__name__/__name__ViewController.swift.tt` if your command is `generate TEMPLATE_SET hello`.
+
+### Template file rule
+
+The template file is ERB template that have extension `.tt`.
+Enoki pass name to template engine.
+
+If your template is...
+
+```swift
+import UIKit
+
+class <%= name %>ViewController: UIViewController {
+    override func viewDidLoad() {
+        super.viewDidLoad()
+    }
+}
+```
+
+and run generate command with name `hello`, then you got following result.
+
+```swift
+import UIKit
+
+class HelloViewController: UIViewController {
+    override func viewDidLoad() {
+        super.viewDidLoad()
+    }
+}
+```
 
 ## Contributing
 
@@ -24,4 +92,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/slight
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/enoki.gemspec

@@ -8,20 +8,21 @@ Gem::Specification.new do |spec|
   spec.version = Enoki::VERSION
   spec.authors = ["slightair"]
   spec.email = ["arksutite@gmail.com"]
-  
+
   spec.summary = %q{Code generator for Xcode project.}
-  spec.description = %q{Code generator for Xcode project.}
+  spec.description = %q{Code generator for Xcode project. You can manage multiple user-defined file template set in your project.}
   spec.homepage = "https://github.com/slightair/enoki"
   spec.license = "MIT"
-  
+
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features|examples)/})
   end
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  
+
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
-  
-  spec.add_dependency 'thor'
+
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "xcodeproj", "~> 1.5"
 end

data/lib/enoki/cli/common.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'xcodeproj'
 
 module Enoki
   class CLI < Thor
@@ -38,6 +39,10 @@ module Enoki
       def templates
         Dir.glob(File.join(template_dir, "*/")).map { |f| File.basename(f) }
       end
+
+      def project
+        @project ||= Xcodeproj::Project.open(project_file_path)
+      end
     end
   end
 end

data/lib/enoki/cli/generate.rb

@@ -2,8 +2,9 @@ require 'pathname'
 
 module Enoki
   class CLI < Thor
-    NAME_PLACEHOLDER = '__name__'
-    EXT_TEMPLATE = '.tt'
+    NAME_PLACEHOLDER = "__name__"
+    EXT_TEMPLATE = ".tt"
+    SOURCE_CODE_EXT_LIST = %w(c m mm swift).map { |ext| ".#{ext}" }
 
     include Thor::Actions
 
@@ -21,17 +22,42 @@ module Enoki
       end
 
       file_list.each do |path|
+        resolved_path = Pathname.new(path.to_path.gsub(NAME_PLACEHOLDER, name.capitalize).chomp(EXT_TEMPLATE))
         source_path = path.expand_path(selected_template_root).to_path
-        dest_path = path.expand_path(project_root).to_path.gsub(NAME_PLACEHOLDER, name.capitalize).chomp(EXT_TEMPLATE)
+        dest_path = resolved_path.expand_path(project_root).to_path
 
         template(source_path, dest_path, context: context_for_template(name))
+        add_file_reference(resolved_path)
       end
+
+      project.save
     end
 
     no_commands do
       def context_for_template(name)
         binding
       end
+
+      def add_file_reference(path)
+        path_list = path.to_path.split(File::SEPARATOR)
+        group = project.root_object.main_group
+
+        while path_list.size > 1
+          dir = path_list.shift
+          next_group = group.children.find { |g| g.path == dir } || group.new_group(dir, dir)
+          group = next_group
+        end
+
+        file = path_list.shift
+        file_ref = group.files.find { |f| f.path == file } || group.new_reference(file)
+
+        if SOURCE_CODE_EXT_LIST.include?(path.extname)
+          target = project.targets.first
+          if target
+            target.source_build_phase.add_file_reference(file_ref, true)
+          end
+        end
+      end
     end
   end
 end

data/lib/enoki/cli/show.rb

@@ -1,6 +1,6 @@
 module Enoki
   class CLI < Thor
-    desc "settings", "show settings"
+    desc "show", "show settings"
     def show
       [:template_dir, :project_root_dir, :project_file_path].each do |e|
         puts("#{e}: #{send(e)}")

data/lib/enoki/cli.rb

@@ -6,3 +6,13 @@ require 'enoki/cli/init'
 require 'enoki/cli/show'
 require 'enoki/cli/list'
 require 'enoki/cli/generate'
+
+module Enoki
+  class CLI < Thor
+    desc "version", "print enoki version"
+    def version
+      puts Enoki::VERSION
+    end
+    map %w(-v --version) => :version
+  end
+end

data/lib/enoki/version.rb

@@ -1,3 +1,3 @@
 module Enoki
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enoki
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - slightair
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,17 +42,32 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Code generator for Xcode project.
+        version: '1.5'
+description: Code generator for Xcode project. You can manage multiple user-defined
+  file template set in your project.
 email:
 - arksutite@gmail.com
 executables:
@@ -65,6 +80,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- assets/project_file_tree.png
 - bin/enoki
 - enoki.gemspec
 - lib/enoki.rb