ruby_yacht 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60a4d2f558965415e5cd128391116e187b05c165
-  data.tar.gz: fa574d48c920037379ecf355ce1e07a31a5795ff
+  metadata.gz: 84782d5ec6a5667641c4e5ac79af922256a343b9
+  data.tar.gz: fac43df97940c4e8bcb21b1173b3e8f5c67a9c7a
 SHA512:
-  metadata.gz: 3a534420ae3d0eb73b31ae1f60c930d64bd217cca3717a04e50ac526d291952d024ebb3b604dd97cb5418fda3bc7fd2078220668dc01ca8651919db02d61ea15
-  data.tar.gz: 03bba6e531b6b21bb96250593f06bad135d796bf88bfe21358e92ade3ca194470b2b463a22d00ac5270e53890e9624febffba66d7638842654dac9a12fcce5a0
+  metadata.gz: 09cffa04290fe6a276ca9cf586ddb6ec5ea78df49dc7889a2100c91b3e58ffbd252532352e27900f53cdc191d3d1fd40243e581d0cf949df19f739232d84cd76
+  data.tar.gz: 84c1952058526225483a7a284352f59b47a4d4d9bd788f9cecc8fcdec60eac7bd689b11090e99164faf625cef9722eeca43d7a5d0aaf9ed3e317632359608bc4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_yacht (0.2.0)
+    ruby_yacht (0.4.0.pre1)
 
 GEM
   remote: https://rubygems.org/

data/doc/TODO.md

@@ -8,17 +8,10 @@ for open tickets.
   approach
 * Look into issues with running shell command that has its own command-line
   flags.
-* Add formal documentation on configuration DSL.
 
 # Plugins
 
-* Add documentation on plugin API
-
-# More Command Line Options
-
-* Getting status of containers
-* Starting / stopping individual containers
-* Clearing backups of the hosts file
+* Better support for rails apps with no database
 
 # More customization
 

data/lib/ruby_yacht/dsl/app.rb

@@ -14,11 +14,14 @@ module RubyYacht
     # when building it.
     #
     # For instance, this would be `rails` for a Rails app.
-    attr_accessor :app_type
+    attr_accessor :server_type
     
     # The port that the app listens on.
     attr_accessor :port
 
+    # The name of the database that this app uses as its data store.
+    attr_accessor :database_name
+
     # This method gets the name of the image / container that this app will run
     # in.
     #
@@ -26,7 +29,23 @@ module RubyYacht
     #
     # * *project: RubyYacht::Project*  The project the app is running in.
     def container_name(project)
-      return "#{project.system_prefix}-#{self.name}"
+      if project.system_prefix == self.name
+        return "#{project.system_prefix}"
+      else
+        return "#{project.system_prefix}-#{self.name}"
+      end
+    end
+
+    # This method gets the database that the app connects to.
+    #
+    # ### Parameters
+    #
+    # * *project: RubyYacht::Project*   The project the app is running in.
+    #
+    # ### Returns
+    # RubyYacht::Database
+    def database(project)
+      project.databases.find { |database| database.name == database_name }
     end
     
     # This class provide's the DSL for configuring an app.
@@ -43,9 +62,9 @@ module RubyYacht
       # ### Parameters
       #
       # * *name: String* The name of the app.
-      def initialize(name, app_type = nil)
+      def initialize(name, server_type = nil)
         @name = name.to_sym
-        @app_type = app_type
+        @server_type = server_type
         load_custom_attributes
       end
       
@@ -57,9 +76,15 @@ module RubyYacht
       add_attribute :repository_name
       
       ##
-      # :method: app_type
-      # You can call `app_type :foo` to set the app's `app_type`.
-      add_attribute :app_type
+      # :method: database_name
+      # You can call `database 'foo'` to tell the app to use the database server
+      # named `foo`.
+      add_attribute :database_name, nil, false
+      
+      ##
+      # :method: server_type
+      # You can call `server_type :foo` to set the app's `server_type`.
+      add_attribute :server_type
       
       ##
       # :method: port
@@ -73,11 +98,13 @@ module RubyYacht
       #
       # If they haven't, this will raise an exception.
       #
-      # It also checks that the app type has been defined in the configuration.
+      # It also checks that the server type has been defined in the
+      # configuration.
       def check_required_attributes
         super
-        unless RubyYacht.configuration.find_app_type(@app_type)
-          raise "App has invalid app type `#{@app_type}`"
+        server_type = RubyYacht.configuration.find_server_type(@server_type)
+        unless server_type && server_type.container_type == :app
+          raise "App has invalid server type `#{@server_type}`"
         end
       end
     end

data/lib/ruby_yacht/dsl/configuration.rb

@@ -1,6 +1,6 @@
 require_relative 'project'
 require_relative 'hook'
-require_relative 'app_type'
+require_relative 'server_type'
 
 module RubyYacht
   # This class stores the configuration for the system.
@@ -16,7 +16,7 @@ module RubyYacht
     def clear
       @projects = []
       @hooks = []
-      @app_types = []
+      @server_types = []
     end
     
     # The projects that are part of this system.
@@ -29,7 +29,7 @@ module RubyYacht
 
     # The app types that we can support.
     # Each entry is a Symbol.
-    attr_accessor :app_types
+    attr_accessor :server_types
 
     # This method pulls up the hooks that we have defined.
     #
@@ -52,17 +52,17 @@ module RubyYacht
       end
     end
 
-    # This method finds an app type by name.
+    # This method finds an server type by name.
     #
     # ### Parameters
     #
-    # * **name: Symbol**    The name of the app type to return.
+    # * **name: Symbol**    The name of the server type to return.
     #
     # ### Returns
     #
-    # The RubyYacht::AppType with that name.
-    def find_app_type(name)
-      self.app_types.find { |type| type.name == name }
+    # The RubyYacht::ServerType with that name.
+    def find_server_type(name)
+      self.server_types.find { |type| type.name == name }
     end
     
     # This method provides a DSL for top-level configuration.
@@ -96,20 +96,20 @@ module RubyYacht
       add_object_list :hook, RubyYacht::Hook::DSL
 
       ##
-      # :method: app_type
+      # :method: server_type
       #
-      # This method adds an app type to the configuration.
+      # This method adds a server type to the configuration.
       #
       # This takes type's name as its argument. It also takes a block which you
       # can use to configure the type, using
-      # RubyYacht::AppType::DSL.
-      add_object_list :app_type, RubyYacht::AppType::DSL
+      # RubyYacht::ServerType::DSL.
+      add_object_list :server_type, RubyYacht::ServerType::DSL
 
       # The path for files and other resources from configuration hooks.
       attr_accessor :hook_folder
 
       # The app type for hooks that we are defining in the current block.
-      attr_accessor :hook_app_type
+      attr_accessor :hook_server_type
 
       # This method sets default attributes for a group of hooks.
       #
@@ -121,7 +121,7 @@ module RubyYacht
       # * **folder: String**    The full path to the script folder.
       # * **block**             A block for adding the hooks.
       def add_hooks(options = {}, &block)
-        keys = [:folder, :app_type]
+        keys = [:folder, :server_type]
         old_options = {}
         keys.each do |key|
           old_options[key] = self.send("hook_#{key}")
@@ -174,16 +174,16 @@ module RubyYacht
         add_hook :during, event_type, &block
       end
       
-      creates_object Configuration, %w(projects hooks app_types)
+      creates_object Configuration, %w(projects hooks server_types)
 
       private
 
       def add_hook(event_time, event_type, &block)
         folder = hook_folder
-        type = hook_app_type
+        type = hook_server_type
         hook event_time, event_type do
           script_folder folder
-          app_type type
+          server_type type
           instance_eval(&block)
         end
       end
@@ -203,11 +203,11 @@ module RubyYacht
       self.configuration.send("#{field}=", self.configuration.send(field) + new_configuration.send(field))
     end
 
-    new_configuration.app_types.each do |type|
-      if self.configuration.app_types.any? { |existing| existing.name == type.name }
-        raise "App type already registered: #{type.name}"
+    new_configuration.server_types.each do |type|
+      if self.configuration.server_types.any? { |existing| existing.name == type.name }
+        raise "Server type already registered: #{type.name}"
       end
-      self.configuration.app_types << type
+      self.configuration.server_types << type
     end
   end
   

data/lib/ruby_yacht/dsl/database.rb

@@ -9,17 +9,31 @@ module RubyYacht
     # The name of the database
     attr_accessor :name
     
+    # The type of database server we're using.
+    attr_accessor :server_type
+    
     # The username we use to connect to the database
     attr_accessor :username
     
     # The password we use to connect to the database
     attr_accessor :password
+
+    # The database-specific part of the container name for this database.
+    attr_accessor :container_label
     
     # Whether the database is running on the same machine as the app servers.
     def local?
       host == 'localhost'
     end
 
+    # This method gets the name of the container and image for this database.
+    #
+    # This will be the project's prefix followed by the database's container
+    # label.
+    def container_name(project)
+      "#{project.system_prefix}-#{container_label}"
+    end
+
     # This class provides a DSL for configuring a database.
     #
     # You can access this DSL by calling `database` within `RubyYacht::Project::DSL`.
@@ -28,6 +42,18 @@ module RubyYacht
       include RubyYacht::DSL::Base
       extend RubyYacht::DSL::Base::ClassMethods
       
+      # This initializer starts the DSL for the database.
+      #
+      # ### Parameters
+      #
+      # * **name: String**          The name of the database.
+      # * **server_type: Symbol**   The type of database server this is.
+      def initialize(name, server_type = nil)
+        @name = name
+        @server_type = server_type
+        load_custom_attributes
+      end
+      
       ##
       # :method: host
       # You can call `host 'db.test.com'` to set the database's host.
@@ -39,6 +65,12 @@ module RubyYacht
       # named `my_database`.
       add_attribute :name
       
+      #
+      # :method: server_type
+      # You can call `server_type` :sqlite` to tell the apps to use the database
+      # server type sqlite.
+      add_attribute :server_type
+      
       ##
       # :method: username
       # You can call `username 'db-user'` to tell the apps to connect to the
@@ -51,7 +83,28 @@ module RubyYacht
       # password `testpass`.
       add_attribute :password
       
+      ##
+      # :method: container_label
+      # You can call `container_label 'mysql'` to give this database a container
+      # name that is {project}-mysql.
+      add_attribute :container_label, :database
+      
       creates_object Database
+      
+      # This method checks that all of the required attributes have been set on
+      # the object.
+      #
+      # If they haven't, this will raise an exception.
+      #
+      # It also checks that the server type has been defined in the
+      # configuration.
+      def check_required_attributes
+        super
+        server_type = RubyYacht.configuration.find_server_type(@server_type)
+        unless server_type && server_type.container_type == :database
+          raise "Database has invalid server type `#{@server_type}`"
+        end
+      end
     end
   end
 end

data/lib/ruby_yacht/dsl/dsl.rb

@@ -188,6 +188,14 @@ module RubyYacht
           @copied_attributes = attributes
           @created_type = type
         end
+
+        # This method gets the attribute that server types can use to specify
+        # custom attributes for this DSL type.
+        #
+        # The default is `server_attributes`.
+        def custom_attribute_method
+          :server_attributes
+        end
       end
 
       # This initializer creates a new DSL instance.
@@ -207,14 +215,12 @@ module RubyYacht
         end
 
         if self.class.created_type
-          dsl_type = self.class.created_type.name.split('::').last.downcase
-          RubyYacht.configuration.app_types.each do |app_type|
-            next if @app_type && app_type.name != @app_type
-            method_name = "#{dsl_type}_attributes"
-            if app_type.respond_to?("#{dsl_type}_attributes")
-              attributes = app_type.send(method_name)
+          RubyYacht.configuration.server_types.each do |server_type|
+            next if @server_type && server_type.name != @server_type
+            if server_type.respond_to?(self.class.custom_attribute_method)
+              attributes = server_type.send(self.class.custom_attribute_method)
               attributes.each do |attribute|
-                attribute = attribute.merge(name: "#{app_type.name}_#{attribute[:name]}")
+                attribute = attribute.merge(name: "#{server_type.name}_#{attribute[:name]}")
                 load_custom_attribute(attribute)
               end
             end
@@ -263,7 +269,7 @@ module RubyYacht
         defaults.each do |name, value|
           copy =
             case value
-            when TrueClass, FalseClass, Fixnum
+            when TrueClass, FalseClass, Fixnum, Symbol
               value
             else
               value.dup

data/lib/ruby_yacht/dsl/hook.rb

@@ -16,19 +16,19 @@ module RubyYacht
     # The type of event that this hook is attached to.
     attr_accessor :event_type
 
-    # The type of app that this hook applies to.
-    attr_accessor :app_type
+    # The type of server that this hook applies to.
+    attr_accessor :server_type
 
-    # The path to the script that contains the code for this hook.
-    attr_accessor :script_path
+    # The path to the file that we should copy into the image for this hook.
+    attr_accessor :copied_file_path
 
     # The command that we should run for this hook.
     attr_accessor :command
 
     # The name of the file containing the code for this hook.
-    def script_name
-      return '' unless script_path
-      File.basename(script_path)
+    def copied_file_name
+      return '' unless copied_file_path
+      File.basename(copied_file_path)
     end
 
     # This class provides a DSL for configuring hooks.
@@ -46,16 +46,15 @@ module RubyYacht
       def initialize(event_time, event_type)
         @event_time = event_time
         @event_type = event_type
-        @script_path = nil
         load_custom_attributes
       end
 
       ##
-      # :method: app_type
+      # :method: server_type
       #
-      # You can call `app_type :rails` to signify that this hook applies to
+      # You can call `server_type :rails` to signify that this hook applies to
       # rails apps.
-      add_attribute :app_type
+      add_attribute :server_type
 
       ##
       # :method: command
@@ -64,6 +63,22 @@ module RubyYacht
       # command `whoami`. You can also set the command through `run_script`, if
       # the hook runs a script file included with the plugin.
       add_attribute :command
+      
+      ##
+      # :method: copy_file
+      #
+      # You can call `copy_file 'foo.txt'` to signify that this hook should
+      # copy a file called `foo.txt` from the hook's script folder to
+      # `/var/docker`.
+      #
+      # You can pair this with a command if you want to move it from that
+      # location in /var/docker into a custom location inside your code folder.
+      #
+      # The file copying happens at the time the image has built.
+      #
+      # When setting this attribute, you must provide another command using the
+      # `command` method.
+      add_attribute :copy_file, nil, false
 
       ##
       # :method: script_folder
@@ -82,7 +97,7 @@ module RubyYacht
       #
       # * **name: String**    The filename of the script.
       def run_script(name)
-        @script_path = File.join(@script_folder || '.', name)
+        @copy_file = name
         @command = "/var/docker/#{name}"
       end
       
@@ -94,12 +109,17 @@ module RubyYacht
       # This will also check that the app type is valid.
       def check_required_attributes
         super
-        unless RubyYacht.configuration.find_app_type(@app_type)
-          raise "Hook has invalid app type `#{@app_type}`"
+        unless RubyYacht.configuration.find_server_type(@server_type)
+          raise "Hook has invalid app type `#{@server_type}`"
         end
       end
+      
+      def create_object
+        @copied_file_path = File.join(@script_folder || '.', @copy_file) if @copy_file
+        super
+      end
 
-      creates_object RubyYacht::Hook, %w(event_time event_type script_path app_type command)
+      creates_object RubyYacht::Hook, %w(event_time event_type copied_file_path server_type command)
     end
   end
 end

data/lib/ruby_yacht/dsl/project.rb

@@ -27,13 +27,14 @@ module RubyYacht
     # keeping it entirely inside the container.
     attr_accessor :check_out_locally
     
-    # The configuration for the database. This is a RubyYacht::Database.
-    attr_accessor :database
+    # The configuration for the databases. Each entry is a RubyYacht::Database.
+    attr_accessor :databases
     
     # The configuration for the apps. Each entry is a RubyYacht::App.
     attr_accessor :apps
     
-    # The configuration for the DNS for the apps. This is a RubyYacht::DnsServer.
+    # The configuration for the DNS for the apps. This is a
+    # RubyYacht::DnsServer.
     attr_accessor :dns_server
 
     # The name of the primary app for the project.
@@ -108,12 +109,10 @@ module RubyYacht
       ##
       # :method: database
       #
-      # You can call `database` to configure the database for the project.
+      # You can call `database` to configure a database for the project.
       # This takes a block for configuring the database, which allows you to
       # call methods in RubyYacht::Database::DSL
-      #
-      # You must call this in your project config.
-      add_object :database, RubyYacht::Database::DSL
+      add_object_list :database, RubyYacht::Database::DSL
       
       ##
       # :method: dns_server
@@ -133,12 +132,26 @@ module RubyYacht
       # For the app type with the name `foo`, this will create a `foo_app`
       # method on the DSL that builds an app with the type `foo`.
       def load_app_initializers
-        RubyYacht.configuration.app_types.each do |app_type|
-          define_singleton_method "#{app_type.name}_app" do |name, &block|
-            app name, app_type.name, &block
+        RubyYacht.configuration.server_types.each do |server_type|
+          method_name = "#{server_type.name}_#{server_type.container_type}"
+          define_singleton_method method_name do |name, &block|
+            self.public_send(
+              server_type.container_type,
+              name,
+              server_type.name,
+              &block
+            )
           end
         end
       end
+
+      # This method gets the attribute that server types can use to specify
+      # custom attributes for this DSL type.
+      #
+      # This DSL uses `project_attributes`.
+      def self.custom_attribute_method
+        :project_attributes
+      end
     end
   end
 end