generamba 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffb2a6a54f2534abe4a3a94904ac75c4dfc375cf
+  data.tar.gz: beef4c78efff15575167171b8ac21293ee34d092
+SHA512:
+  metadata.gz: bb416b0ca779e1bc359734e2082a4f4b91e2e078b85ff93ae8d6313f074ca1720a716020f490efa264c83c8439161f63f2fd2f357856d0b4d0424ce10d6b0d1f
+  data.tar.gz: 9147cf3e069cb1d99d3984979943d45d725c80d74fb6831be704b949e904c20b196d17a25ce340f8ca491c2f8b2bd6137e6d0435298efa2e721e9b0cf0db6bee

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in generamba.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    generamba (0.5.0)
+      git
+      liquid
+      settingslogic
+      thor
+      tilt
+      xcodeproj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    claide (0.9.1)
+    colored (1.2)
+    diff-lcs (1.2.5)
+    git (1.2.9.1)
+    i18n (0.7.0)
+    json (1.8.3)
+    liquid (3.0.6)
+    minitest (5.8.1)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    settingslogic (2.0.9)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    xcodeproj (0.28.2)
+      activesupport (>= 3)
+      claide (~> 0.9.1)
+      colored (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  generamba!
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Egor Tolstoy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,51 @@
+### Overview
+
+**Generamba** - это генератор кода, заточенный под работу с Xcode. В первую очередь предназначен для генерации модулей VIPER - но достаточно легко настраивается и для генерации любых других классов.
+
+### Основные особенности
+
+- Из коробки поддерживает работу с *.xcodeproj* файлами - все сгенерированные классы автоматически распределяются как по файловой структуре, так и по группам в проекте.
+- Умеет генерировать как непосредственно код, так и тесты, автоматически распределяя их по правильным таргетам.
+- Основан на работе с [liquid-шаблонами](https://github.com/Shopify/liquid) - синтаксис простой и понятный, особенно в сравнении с шаблонами для Xcode.
+- Создать новый модуль очень просто: `generamba gen MyModule`. Не требуется каждый раз вводить кучу данных - каждому проекту соответствует один конфигурационный файл, содержащий в себе стандартные пути в файловой системе и Xcode-проекте, названия таргетов, информацию об авторе.
+
+
+### Установка
+Проект пока что находится в стадии beta-версии, поэтому не добавлен в общий каталог ruby-gem'ов. Локальная установка осуществляется следующим образом:
+
+1. Склонируйте репозиторий себе на компьютер
+2. В консоли перейдите в директорию проекта
+3. Вызовите команду `gem install generamba`
+
+### Использование
+В настоящий момент Generamba поддерживает две команды:
+
+1. `generamba setup` - вызывается в корневой директории проекта. Помогает автоматически создать и настроить *Rambafile*, описывающий всю конфигурацию, необходимую для генерации кода. В дальнейшем этот файл может быть модифицирован вручную.
+2. `generamba gen MODULE_NAME` - генерирует модуль с указанным названием. В качестве стандартного используется шаблон *viper_module*. Команда поддерживает несколбко дополнительных опций - узнать о них больше поможет команда `generamba help gen`.
+
+В текущей версии нет возможности создавать локальные шаблоны и использовать их для генерации. Пока что используем следующий workaround:
+
+1. `open ~/.rvm/gems/ruby-2.1.6/gems`
+2. Находим директорию *Generamba-x.x.x*
+3. Переходим в *lib/generamba/default_templates/*
+4. Создаем папку с названием нового модуля. В остальном модуль создается по образцу стандартного.
+
+Оптимизация добавления шаблонов является главным приоритетом на данный момент.
+
+### Авторы
+
+- Егор Толстой
+- Андрей Зарембо-Годзяцкий
+
+### Лицензия
+
+MIT
+
+### TODO
+
+- Дать возможность использовать локальный шаблон, указав полный путь до него
+- В Rambafile держать информацию обо всех используемых в проекте шаблонах
+- Вынести из Rambafile информацию, специфичную для текущего автора (имя)
+- Добавить для каждого шаблона возможность модифицировать Podfile проекта
+- Добавить GUI
+- Добавить возможность генерирования тестов по указанным интерфейсным файлам

data/bin/GenerambaSandbox/Rambafile

@@ -0,0 +1,17 @@
+---
+author: Egor Tolstoy
+company: Rambler&Co
+project_name: GenerambaSandbox
+prefix: 
+xcodeproj_path: "/Users/etolstoy/Generamba/GenerambaSandbox/GenerambaSandbox.xcodeproj"
+project_target: GenerambaSandbox
+project_file_path: GenerambaSandbox/Classes/Modules/
+project_group_path: GenerambaSandbox/Classes/Modules/
+test_target: GenerambaSandboxTests
+test_file_path: GenerambaSandboxTests/Classes/Modules/
+test_group_path: GenerambaSandboxTests/Classes/Modules/
+templates:
+- {name: default_template, git: 'https://github.com/igrekde/default_template.git'}
+- {name: rambler_viper_controller, local: '/Users/etolstoy/Generamba/rambler_viper_controller'}
+- {name: rambler_viper_controller2, local: '/Users/etolstoy/Generamba/rambler_viper_controller2'}
+- {name: default}

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "generamba"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/generamba

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'generamba'
+
+Generamba::CLI::Application.start(ARGV)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/generamba.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'generamba/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'generamba'
+  spec.version       = Generamba::VERSION
+  spec.authors       = ['Egor Tolstoy', 'Andrey Zarembo']
+  spec.email         = 'e.tolstoy@rambler-co.ru'
+
+  spec.summary       = 'Advanced code generator for Xcode projects with a nice and flexible template system.'
+  spec.description   = 'Generamba is a powerful and easy-to-use Xcode code generator. It provides a project-based configuration, flexible templates system, the ability to generate code and tests simultaneously.'
+  spec.homepage      = 'https://github.com/rambler-ios/Generamba'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['generamba']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'xcodeproj'
+  spec.add_dependency 'liquid'
+  spec.add_dependency 'tilt'
+  spec.add_dependency 'settingslogic'
+  spec.add_dependency 'git'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/generamba.rb

@@ -0,0 +1,17 @@
+require 'xcodeproj'
+
+module Generamba
+  require 'generamba/constants/constants.rb'
+  require 'generamba/constants/rambafile_constants.rb'
+  require 'generamba/constants/rambaspec_constants.rb'
+  require 'generamba/cli/cli.rb'
+  require 'generamba/code_generation/code_module.rb'
+  require 'generamba/code_generation/module_template.rb'
+  require 'generamba/configuration/project_configuration'
+  require 'generamba/code_generation/content_generator.rb'
+  require 'generamba/code_generation/rambafile_generator.rb'
+  require 'generamba/module_generator.rb'
+  require 'generamba/template/processor/template_processor.rb'
+  require 'generamba/configuration/user_preferences.rb'
+  require 'generamba/template/creator/template_creator.rb'
+end

data/lib/generamba/cli/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require 'xcodeproj'
+require 'liquid'
+require 'tilt'
+require 'git'
+require 'generamba/cli/gen_command.rb'
+require 'generamba/cli/setup_command.rb'
+require 'generamba/cli/thor_extension.rb'
+require 'generamba/cli/template/template_group.rb'
+
+module Generamba::CLI
+	class Application < Thor
+		
+	end
+end

data/lib/generamba/cli/gen_command.rb

@@ -0,0 +1,26 @@
+require 'thor'
+
+module Generamba::CLI
+  class Application < Thor
+
+    desc 'gen [MODULE_NAME] [TEMPLATE_NAME_KEY]', 'Creates a new VIPER module with a given name from a specific template'
+    method_option :description, :aliases => '-d', :desc => 'Provides a full description to the module'
+    def gen(module_name, template_name)
+
+      does_rambafile_exist = Dir[RAMBAFILE_NAME].count > 0
+
+      if (does_rambafile_exist == false)
+        puts('Rambafile not found! Run `generamba setup` in the working directory instead!')
+        return
+      end
+
+      default_module_description = "#{module_name} module"
+      module_description = options[:description] ? options[:description] : default_module_description
+
+      generator = Generamba::ModuleGenerator.new()
+      generator.generate_module(template_name, module_name, module_description)
+
+    end
+
+  end
+end

data/lib/generamba/cli/setup_command.rb

@@ -0,0 +1,80 @@
+require 'thor'
+require 'xcodeproj'
+require 'liquid'
+require 'tilt'
+require 'git'
+require 'generamba/constants/rambafile_constants.rb'
+
+module Generamba::CLI
+  class Application < Thor
+    include Generamba
+
+    desc 'setup', 'Creates a Rambafile with a config for a given project'
+    def setup
+      properties = {}
+
+      git_username = Git.init.config['user.name']
+
+      if git_username != nil && yes?("Your name in git is configured as #{git_username}. Do you want to use it in code headers? (yes/no)")
+        username = git_username
+      else
+        username = ask_non_empty_string('The author name which will be used in the headers:', 'User name should not be empty')
+      end
+
+      Generamba::UserPreferences.save_username(username)
+
+      properties[COMPANY_KEY] = ask('The company name which will be used in the headers:')
+
+      project_name = Pathname.new(Dir.getwd).basename.to_s
+      is_right_project_name = yes?("The name of your project is #{project_name}. Do you want to use it? (yes/no)")
+      properties[PROJECT_NAME_KEY] = is_right_project_name ? project_name : ask_non_empty_string('The project name:', 'Project name should not be empty')
+      properties[PROJECT_PREFIX_KEY]  = ask('The project prefix (if any):')
+
+      project_files = Dir['*.xcodeproj']
+      count = project_files.count
+      if count == 1
+        is_right_path = yes?("The path to a .xcodeproj file of the project is #{project_files[0]}. Do you want to use it? (yes/no)")
+        xcode_path = is_right_path ? project_files[0] : ask('The path to a .xcodeproj file of the project:')
+      else
+        xcode_path = ask('The path to a .xcodeproj file of the project:')
+      end
+
+      properties[XCODEPROJ_PATH_KEY] = xcode_path
+      project = Xcodeproj::Project.open(xcode_path)
+
+      targets_prompt = ''
+      project.targets.each_with_index { |element, i| targets_prompt += ("#{i}. #{element.name}" + "\n") }
+
+      project_target = ask_index("Select the appropriate target for adding your MODULES (type the index):\n" + targets_prompt,project.targets)
+      test_target = ask_index("Select the appropriate target for adding your TESTS (type the index):\n" + targets_prompt,project.targets)
+
+      should_use_same_paths = yes?('Do you want to use the same paths for your files both in Xcode and the filesystem? (yes/no)')
+      if should_use_same_paths
+        project_group_path = ask('The default path for creating new modules:')
+        project_file_path = project_group_path
+
+        test_group_path = ask('The default path for creating tests:')
+        test_file_path = test_group_path
+      else
+        project_group_path = ask('The default path for creating new modules (in Xcode groups):')
+        project_file_path = ask('The default path for creating new modules (in the filesystem):')
+
+        test_group_path = ask('The default path for creating tests (in Xcode groups):')
+        test_file_path = ask('The default path for creating tests (in the filesystem):')
+      end
+
+      properties[PODFILE_PATH_KEY]  = ask('The Podfile path (if any):')
+      properties[CARTFILE_PATH_KEY]  = ask('The Cartfile path (if any):')
+
+      properties[PROJECT_TARGET_KEY] = project_target.name
+      properties[PROJECT_FILE_PATH_KEY] = project_file_path
+      properties[PROJECT_GROUP_PATH_KEY] = project_group_path
+      properties[TEST_TARGET_KEY] = test_target.name
+      properties[TEST_FILE_PATH_KEY] = test_file_path
+      properties[TEST_GROUP_PATH_KEY] = test_group_path
+
+      Generamba::RambafileGenerator.create_rambafile(properties)
+      say('Rambafile successfully created! Now add some templates to the Rambafile and run `generamba template install`.')
+    end
+  end
+end

data/lib/generamba/cli/template/template_create_command.rb

@@ -0,0 +1,29 @@
+module Generamba::CLI
+  class Template < Thor
+    include Generamba
+
+    desc 'create [TEMPLATE_NAME]', 'Creates a new Generamba template with a given name'
+    def create(template_name)
+      summary = ask('The brief description of your new template:')
+      author = ask('Who is the author of this template:')
+      license = ask('What license will be used (e.g. MIT):')
+
+      has_dependencies = yes?('Will your template contain any third-party dependencies (available via Cocoapods or Carthage)? (yes/no)')
+      if has_dependencies
+        dependencies = ask_loop('Enter the name of your dependency (empty string to stop):')
+      end
+
+      properties = {
+          TEMPLATE_NAME_KEY => template_name,
+          TEMPLATE_SUMMARY_KEY => summary,
+          TEMPLATE_AUTHOR_KEY => author,
+          TEMPLATE_LICENSE_KEY => license,
+          TEMPLATE_DEPENDENCIES_KEY => dependencies
+      }
+
+      template_creator = Generamba::TemplateCreator.new
+      template_creator.create_template(properties)
+      say("The template #{template_name} is successfully generated! Now add some file templates into it.")
+    end
+  end
+end

data/lib/generamba/cli/template/template_group.rb

@@ -0,0 +1,12 @@
+require 'generamba/cli/template/template_install_command.rb'
+require 'generamba/cli/template/template_create_command.rb'
+
+module Generamba::CLI
+  class Application < Thor
+    register(Generamba::CLI::Template, 'template', 'template <command>', 'Provides a set of commands for working with templates')
+  end
+
+  class Template < Thor
+
+  end
+end