comodule 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fda5e5972ccfc052cf2bd83e2b68dbf65969fd3
-  data.tar.gz: cecaed5a265d776050d1cd107fe429eaa1482795
+  metadata.gz: 23d9fa321c17d22373381ce0242591cd400c8172
+  data.tar.gz: b31138a32bce6be47ef27abda6507a51f3a32c55
 SHA512:
-  metadata.gz: 83a663b9a20534b3e7020516a89634e3d433306e9da169e99fe9e68a33553bade483e0949234cd5f3ce3ad87d4462bed0a6a3632e1d0562f75935c9711727ad0
-  data.tar.gz: 42b180d2dfda6868fb9cecac6ddae4afeb6720abe8b3f3b150bd75ec2d0a0b797f10ddfa076f7b3a318c5cc3fc61e30bdf63d1c41544fb79548d7a31ce6fa624
+  metadata.gz: 0f117e97feb9fe3ee562e7de964eb4d8268a3ed2dd04b607d71622e4aa692e6e91c6430f2e5b461ef14e538a23db559b7710f4ce5ba817bb4c304cdb76d77352
+  data.tar.gz: f763340017a7d42c297d3dccfae559c8a5f11cb0270e76edc2896ad682282e1d68d9fac7db762f1f9875ec821cf27e9c29825f7ae22d84da526e6027f9c25673

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/rails/experiment/vendor/gems

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.0 (2014-10-08)
+
+- Features
+
+  - Implemented rake tasks
+  - Add a rails project for tests

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in comodule.gemspec
 gemspec
-
-gem 'rails', '~> 4.0.0'

data/README.md

@@ -6,20 +6,78 @@ comodule
 ## 概要
 
   * モジュール
+    * Deployment
     * ConfigSupport
     * UniArray
 
   * クラスの拡張
-    * Hash
-      * pullout, pullout!
     * String
       * standardize
 
 ## モジュール
 
+### Deployment
+
+AWS CloudFormation を使って、AWS 上へのデプロイを容易にします。
+`Rails.root` の直下にデプロイに必要なファイルを格納する `platform` ディレクトリを作り、構築する環境の名前のディレクトリをその中に作ります。ここでは、`staging` とします。
+
+```ruby
+platform = Comodule::Deployment::Platfrom.new 'staging'
+
+# ローカルのソースを S3 に acl: :private でアップする。
+platform.archive_repository
+platform.upload_archive
+
+# スタックの作成
+platform.create_stack
+```
+
+これで `platform/cloud_formation/template.json.erb` を使って CloudFormation のスタックを作成します。この際、変数 `config` で `config.yml` または `secret_config.yml` で設定した項目にアクセスできます。
+例えば、
+
+```yaml
+stack_name_prefix: trial
+application: &application Trial
+project_root: !str /ec2-user/projects
+rails_root: !str /ec2-user/projects/trial
+
+ec2_instance:
+  instance_type: m3.medium
+  ami: ami-a1bec3a0
+  name: *application
+  key_name: ssh_key
+  iam_role: dev_master
+  security_group: aa-1a2b3c4d
+
+aws_access_credentials:
+  cloud_formation:
+    region: ap-northeast-1
+```
+
+```json
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Description": "It creates a Rails stack.",
+
+  "Resources": {
+    "System": {
+      "Type": "AWS::EC2::Instance",
+      "Properties": {
+        "InstanceType": "<%= config.ec2_instance.instance_type %>",
+        "ImageId": "<%= config.ec2_instance.ami %>",
+        "KeyName": "<%= config.ec2_instance.key_name %>",
+        "IamInstanceProfile": { "Ref": "InstanceProfile" },
+        "SecurityGroupIds": ["<%= config.ec2_instance.security_group %>"],
+        "Tags": [{"Key": "Name", "Value": "<%= config.ec2_instance.name %>"}],
+      }
+    }
+  }
+}
+```
+
 ### ConfigSupport
 
-定義なしにアトリビュートを保存できる初期情報などを扱うのに適した汎用オブジェクト。
+定義なしにアトリビュートを保存できる初期情報などを扱うのに適した汎用オブジェクトです。
 
 ```ruby
 config = Comodule::ConfigSupport::Config.new
@@ -33,6 +91,15 @@ config.port
 # => "3000"
 ```
 
+但し、あくまでも `Object` のサブクラスなので、`Object#methods`, `Object#protected_methods`, `Object#private_methods` に含まれる名前のディレクティブを作ることはできません。
+
+```ruby
+config = Comodule::ConfigSupport::Config.new(
+  system: 'app_name'
+)
+# => ArgumentError
+```
+
 デフォルトでは、設定されていないディレクティブは nil を返します。
 
 ```ruby
@@ -103,6 +170,51 @@ config.to_hash
 # => {:host=>"example.com", :port=>"3000"}
 ```
 
+`#merge` で二つの `Config` オブジェクトをマージできます。`#+()` はそのエイリアスです。マージは再帰的に行われます。
+
+```ruby
+config = Comodule::ConfigSupport::Config.new(
+  host: 'example.com',
+  db: {
+    host: 'rds',
+    database: 'app_development',
+    username: 'ec2-user',
+    schedule: {
+      boot: '08-00-00',
+    }
+  }
+)
+
+config2 = Comodule::ConfigSupport::Config.new(
+  port: '3000',
+  db: {
+    host: 'rds',
+    password: 'secret',
+    schedule: {
+      shutdown: '22-00-00'
+    }
+  }
+)
+
+config = config1 + config2
+
+config.to_hash
+# => {
+  host: 'example.com',
+  port: '3000',
+  db: {
+    host: 'rds',
+    database: 'app_development',
+    username: 'ec2-user',
+    password: 'secret',
+    schedule: {
+      boot: '08-00-00',
+      shutdown: '22-00-00'
+    }
+  }
+}
+```
+
 ### UniArray
 
 要素の重複をさせない `Array` のサブクラス。スニペットと言っていいくらい簡単なコードで出来ています。
@@ -160,46 +272,6 @@ Comodule::CustomizeClass.customize
 として、読み込みます。このメソッドは複数回呼び出すとエラーになりますので、気をつけてください。
 尚、Comodule は既存のメソッドをオーバーライドできません。
 
-### Hash
-
-#### pullout, pullout!
-
-ハッシュから指定要素を抜き出して新しいハッシュを返す。
-
-```ruby
-hsh = {
-  date: "20130322",
-  title: "The Tell-Tale Brain",
-  secret_token: "it-is-secret"
-}
-result_hsh = hsh.pullout(:date, :title)
-# => {date: "20130322", title: "The Tell-Tale Brain"}
-```
-
-デフォルトでは未定義の要素は無視します。
-
-```ruby
-hsh = {
-  date: "20130322",
-  title: "The Tell-Tale Brain",
-  secret_token: "it-is-secret"
-}
-result_hsh = hsh.pullout(:date, :title, :author)
-# => {date: "20130322", title: "The Tell-Tale Brain"}
-```
-
-未定義要素へのアクセス時に例外を挙げたいときは `pullout!` を使います。
-
-```ruby
-hsh = {
-  date: "20130322",
-  title: "The Tell-Tale Brain",
-  secret_token: "it-is-secret"
-}
-result_hsh = hsh.pullout!(:date, :title, :author)
-# => ArgumentError: Comodule::CustomizeClass::HashCustom cannot find key 'author' is a Symbol.
-```
-
 ### String
 
 #### standardize

data/comodule.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency "aws-sdk", "~> 1.54"
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
 end

data/copy_to_rails.sh

@@ -0,0 +1,7 @@
+# /bin/bash
+
+rm -rf spec/rails/experiment/vendor/gems/comodule
+
+mkdir -p spec/rails/experiment/vendor/gems/comodule/
+
+ls -a | grep -v -E '^copy_to_rails.sh$|[.]DS_Store$|^[.]$|^[.][.]$|^spec$|^[.]git$' | xargs -I{} cp -R {} spec/rails/experiment/vendor/gems/comodule/

data/lib/comodule.rb

@@ -1,13 +1,43 @@
 require "comodule/version"
-require "rails"
+require 'active_support/all'
 
 module Comodule
+
+  if defined?(Rails)
+    class Railtie < Rails::Railtie
+      rake_tasks { load "tasks/comodule.rake" }
+    end
+  end
+
   autoload :UniArray,       'comodule/uni_array'
   autoload :ConfigSupport,  'comodule/config_support'
   autoload :CustomizeClass, 'comodule/customize_class'
+  autoload :Deployment,     'comodule/deployment'
 
   module CustomizeClass
-    autoload :HashCustom,   'comodule/customize_class/hash_custom'
     autoload :StringCustom, 'comodule/customize_class/string_custom'
   end
+
+  module Deployment
+    autoload :Base,     'comodule/deployment/base'
+    autoload :Platform, 'comodule/deployment/platform'
+    autoload :Helper,   'comodule/deployment/helper'
+
+    module Helper
+      autoload :Base,          'comodule/deployment/helper/base'
+      autoload :SystemUtility, 'comodule/deployment/helper/system_utility'
+      autoload :Aws,           'comodule/deployment/helper/aws'
+      autoload :ShellCommand,  'comodule/deployment/helper/shell_command'
+      autoload :Uploader,      'comodule/deployment/helper/uploader'
+
+      module Aws
+        autoload :Base,           'comodule/deployment/helper/aws/base'
+        autoload :S3,             'comodule/deployment/helper/aws/s3'
+        autoload :CloudFormation, 'comodule/deployment/helper/aws/cloud_formation'
+        autoload :Ec2,            'comodule/deployment/helper/aws/ec2'
+        autoload :Ssl,            'comodule/deployment/helper/aws/ssl'
+        autoload :Rds,            'comodule/deployment/helper/aws/rds'
+      end
+    end
+  end
 end

data/lib/comodule/config_support.rb

@@ -1,51 +1,128 @@
 module Comodule::ConfigSupport
   class Config
+    class << self
+      def original_methods
+        return @original_methods if @original_methods
+
+        @original_methods =  public_instance_methods
+        @original_methods += protected_instance_methods
+        @original_methods += private_instance_methods
+      end
+
+      def combine(config1, config2)
+        new_obj = new
+
+        config1.each do |key, value|
+          new_obj[key] = value
+        end
+
+        config2.each do |key, value|
+          if self === new_obj[key] && self === value
+            new_obj[key] = combine(new_obj[key], value)
+          else
+            new_obj[key] = value
+          end
+        end
+
+        new_obj
+      end
+    end
+
     def initialize(config_hash={})
       config_hash[:configure_type] ||= :soft
+
       config_hash.each do |directive, value|
         value = value.to_sym if directive == :configure_type
+
         if Hash === value
           value[:configure_type] ||= config_hash[:configure_type]
           value = self.class.new(value)
         end
-        instance_variable_set "@#{directive}", value
+
+        set_directive directive, value
+      end
+
+      if block_given?
+        yield self
       end
     end
 
     def method_missing(directive, arg=nil)
       if directive =~ /^(.+)=/
-        arg = arg.to_sym if directive == :configure_type
-        if Hash === arg
-          arg[:configure_type] ||= configure_type
-          arg = self.class.new(arg)
-        end
-        arg = self.class.new(arg) if Hash === arg
-        return instance_variable_set("@#{$1}", arg)
-      end
-      value = instance_variable_get("@#{directive}")
-      if @configure_type == :hard && !value
-        raise ArgumentError, "Comodule::ConfigSupport::Config is missing this directive [#{directive}]."
+        set_directive($1, arg)
+      else
+        get_directive(directive)
       end
-      value
     end
 
     def [](directive)
-      send(directive)
+      get_directive(directive)
     end
 
     def []=(directive, arg)
-      send("#{directive}=", arg)
+      set_directive(directive, arg)
     end
 
-    def to_hash
-      hsh = {}
+    def merge(other_config)
+      self.class.combine(self, other_config)
+    end
+
+    alias + merge
+
+    def each
       instance_variables.each do |variable_name|
         next if variable_name == :@configure_type
+
         key = variable_name.to_s.sub(/@/, '').to_sym
-        hsh[key] = instance_variable_get(variable_name)
+        value = instance_variable_get(variable_name)
+
+        yield key, value
+      end
+    end
+
+    def to_hash
+      hsh = {}
+      each do |key, value|
+        value = value.to_hash if self.class === value
+        hsh[key] = value
       end
       hsh
     end
+
+    def slice(*keys)
+      keys.inject(self.class.new) do |new_obj, key|
+        new_obj[key] = self[key] if self[key]
+        new_obj
+      end
+    end
+
+
+  private
+
+    def get_directive(directive)
+      value = instance_variable_get("@#{directive}")
+      if @configure_type == :hard && !value
+        raise ArgumentError, "Comodule::ConfigSupport::Config is missing this directive [#{directive}]."
+      end
+      value
+    end
+
+    def set_directive(directive, arg)
+      directive = directive.to_sym
+
+      if self.class.original_methods.member?(directive)
+        raise ArgumentError, "You cannot use the directive [#{directive}= #{arg}] same as a member of Object#methods."
+      end
+
+      arg = arg.to_sym if directive == :configure_type
+
+      if Hash === arg
+        arg[:configure_type] ||= configure_type
+        arg = self.class.new(arg)
+      end
+
+      instance_variable_set("@#{directive}", arg)
+    end
   end
 
 

data/lib/comodule/deployment.rb

@@ -0,0 +1,2 @@
+module Comodule::Deployment
+end

data/lib/comodule/deployment/base.rb

@@ -0,0 +1,186 @@
+module Comodule::Deployment::Base
+
+  def self.included(receiver)
+    unless receiver < ::Comodule::Deployment::Helper::SystemUtility
+      receiver.send :include, ::Comodule::Deployment::Helper::SystemUtility
+    end
+    receiver.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def config
+      return @config if @config
+
+      @config = ::Comodule::ConfigSupport::Config.new
+
+      @config += yaml_to_config(aws_config_path) if File.file?(aws_config_path)
+      @config += yaml_to_config(common_config_path) if File.file?(common_config_path)
+      @config += yaml_to_config(config_path)
+
+      @config += yaml_to_config(common_secret_config_path) if File.file?(common_secret_config_path)
+      @config += yaml_to_config(secret_config_path) if File.file?(secret_config_path)
+
+      if @config.config_files
+        @config.config_files.each do |extend_path|
+          path = File.join(platform_root, extend_path)
+          @config += yaml_to_config(path) if File.file?(path)
+        end
+      end
+
+      @config.platform_name = @name
+
+      @config
+    end
+
+    def config_copy
+      return unless config.cp
+
+      rm_rf File.join(test_dir, 'file_copy') if test?
+
+      count = 0
+
+      count += file_copy(common_config_dir)
+      count += file_copy(common_secret_config_dir)
+      count += file_copy(config_dir)
+      count += file_copy(secret_config_dir)
+
+      return count
+    end
+
+    def file_copy(dir)
+      count = 0
+
+      paths = Dir.glob(File.join(dir, '**', '*'))
+
+      order = config.cp.to_hash
+
+      order.each do |key, path_head_list|
+
+        [path_head_list].flatten.each do |path_head|
+          wanted = %r|^#{File.join(dir, key.to_s)}|
+
+          paths.each do |file_path|
+            next unless File.file?(file_path)
+            next unless file_path =~ wanted
+
+            path_tail = file_path.sub(wanted, '')
+
+            path = File.join(path_head, path_tail)
+            path = File.join(test_dir, 'file_copy', path) if test?
+
+            dirname, filename = File.split(path)
+
+            be_dir(dirname)
+
+            if file_path =~ /\.erb$/
+              File.open(path.sub(/\.erb$/, ''), 'w') do |file|
+                file.write render(file_path)
+              end
+            else
+              FileUtils.cp file_path, "#{dirname}/"
+            end
+
+            count += 1
+          end
+        end
+      end
+
+      count
+    end
+
+    def aws_config_path
+      @aws_config_path ||= File.join(platform_root, 'aws_config.yml')
+    end
+
+    def config_dir
+      @config_dir ||= File.join(platform_dir, 'config')
+    end
+
+    def secret_config_dir
+      @secret_config_dir ||= File.join(platform_dir, 'secret_config')
+    end
+
+    def common_config_dir
+      @common_config_dir ||= File.join(platform_root, 'config')
+    end
+
+    def common_secret_config_dir
+      @common_secret_config_dir ||= File.join(platform_root, 'secret_config')
+    end
+
+    def common_config_path
+      @common_config_path ||= File.join(platform_root, 'config.yml')
+    end
+
+    def common_secret_config_path
+      @common_secret_config_path ||= File.join(platform_root, 'secret_config.yml')
+    end
+
+    def config_path
+      @config_path ||= File.join(platform_dir, 'config.yml')
+    end
+
+    def secret_config_path
+      @secret_config_path ||= File.join(platform_dir, 'secret_config.yml')
+    end
+
+    def tmp_dir
+      @tmp_dir ||= be_dir(File.join(platform_dir, 'tmp'))
+    end
+
+    def test_dir
+      @test_dir ||= be_dir(File.join(platform_dir, 'test'))
+    end
+
+    def tmp_projects_dir
+      @tmp_projects_dir ||= be_dir(File.join(tmp_dir, 'projects'))
+    end
+
+    def tmp_project_dir
+      @tmp_project_dir ||= be_dir(File.join(tmp_projects_dir, project_name))
+    end
+
+    def project_name
+      File.basename project_root
+    end
+
+    def git_dir
+      @git_dir ||= File.join(project_root, '.git')
+    end
+
+    def file_path(*path)
+      path = File.join(*path)
+      if path =~ %r|^platform/(.*)|
+        File.join(platform_root, $1)
+      else
+        File.join(platform_dir, path)
+      end
+    end
+
+    def platform_dir
+      @platform_dir ||= File.join(platform_root, name)
+    end
+
+    def name
+      @name
+    end
+
+    def project_name
+      @project_name ||= File.basename(project_root)
+    end
+
+    def project_root
+      @project_root ||=
+        if defined?(Rails)
+          Rails.root
+        else
+          Dir.getwd
+        end
+    end
+
+    def platform_root
+      @platform_root ||= File.join(project_root, 'platform')
+    end
+  end
+end