mimi-core 0.2.0 → 1.0.0

data/lib/mimi/core/rake.rb

@@ -1,7 +1,53 @@
+# frozen_string_literal: true
+
+# When required, `mimi/core/rake` loads all rake tasks exported by *loaded* modules
+# and current application (found under `app_root_path`).
+#
+# Usage:
+#
+# ```ruby
+# # lib/my_app.rb
+# require 'mimi/core'
+# require 'mimi/db'
+#
+#
+# # lib/tasks/my_task.rake
+# desc 'My application task'
+# task :my_task do
+#   puts
+# end
+#
+#
+# # Rakefile
+# require_relative 'lib/my_app'
+# require 'mimi/core/rake'
+# ```
+#
+# This makes rake tasks exported by `mimi-db` and other loaded modules available:
+#
+# ```ruby
+# $ rake -T
+# rake db:clear                   # Clear database
+# rake db:config                  # Show database config
+# rake db:create                  # Create database
+# ...
+# rake my_task                    # My application task
+# ```
+#
+#
 module Mimi
   module Core
+    #
+    # Mimi::Core::Rake module contains various rake helpers
+    #
     module Rake
+      #
+      # Loads rake tasks exported by *loaded* modules
+      #
       def self.load_rake_tasks
+        unless Mimi.respond_to?(:app_root_path)
+          raise 'Cannot load rake tasks before mimi-core module is loaded'
+        end
         app_and_modules_paths = [Mimi.app_root_path] + Mimi.loaded_modules_paths
         rakefiles = app_and_modules_paths.map do |path|
           Pathname.glob(path.join('lib', 'tasks', '**', '*.rake'))

data/lib/mimi/core/version.rb

@@ -1,5 +1,5 @@
 module Mimi
   module Core
-    VERSION = '0.2.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/lib/mimi/core.rb

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module Mimi
+  #
+  # `Mimi::Core` extends the `Mimi` namespace with its instance methods.
+  #
   module Core
     # Returns the application's root path.
     #
@@ -8,12 +13,17 @@ module Mimi
     # If you need to use a different path as the app root path,
     # use #app_root_path=()
     #
+    # @return [Pathname]
+    #
     def app_root_path
       @app_root_path ||= Pathname.pwd.expand_path
     end
 
     # Sets the application's root path explicitly
     #
+    # @param path [String,Pathname]
+    # @return [Pathname]
+    #
     def app_root_path=(path)
       @app_root_path = Pathname.new(path).expand_path
     end
@@ -24,12 +34,21 @@ module Mimi
     #   Mimi.app_root_path # => /path/to/my_app
     #   Mimi.app_path_to('app', 'models') # => /path/to/my_app/app/models
     #
+    # @param args [Array<String,Pathname>]
+    # @return [Pathname]
+    #
     def app_path_to(*args)
       app_root_path.join(*args)
     end
 
     # Use the given module
     #
+    # Includes the module in the list of *used* Mimi modules. Used modules are automatically
+    # started/stopped when Mimi.start is performed, in the order of appending.
+    #
+    # @param mod [Module]
+    # @param opts [Hash,nil] optional parameters to be passed to the module's .configure method
+    #
     def use(mod, opts = {})
       raise ArgumentError, "#{mod} is not a Mimi module" unless mod < Mimi::Core::Module
       mod.configure(opts)
@@ -37,7 +56,9 @@ module Mimi
       true
     end
 
-    # Returns the list of loaded (require-d) modules
+    # Returns the list of loaded (require'd) modules
+    #
+    # @return [Array<Module>]
     #
     def loaded_modules
       @loaded_modules ||= []
@@ -45,18 +66,25 @@ module Mimi
 
     # Returns the list of used modules
     #
+    # @return [Array<Module>]
+    #
     def used_modules
       @used_modules ||= []
     end
 
     # Returns all loaded module paths, which are defined (non nil)
     #
+    # @return [Array<Pathname>]
+    #
     def loaded_modules_paths
       loaded_modules.map(&:module_path).reject(&:nil?)
     end
 
     # Requires all files that match the glob.
     #
+    # @param glob [String]
+    # @param root_path [Pathname,nil] if not specified, app_root_path will be used
+    #
     def require_files(glob, root_path = app_root_path)
       Pathname.glob(root_path.join(glob)).each do |filename|
         require filename.expand_path
@@ -81,5 +109,7 @@ module Mimi
 end # module Mimi
 
 require_relative 'core/version'
-require_relative 'core/module'
 require_relative 'core/core_ext'
+require_relative 'core/inheritable_property'
+require_relative 'core/module'
+require_relative 'core/manifest'

data/mimi-core.gemspec

@@ -27,8 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '~> 5.0'
-  spec.add_dependency 'hashie', '~> 3.4'
+  spec.add_dependency 'hashie', '~> 3.6'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'pry', '~> 0.10'

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mimi-core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +90,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -113,6 +100,8 @@ files:
 - bin/setup
 - lib/mimi/core.rb
 - lib/mimi/core/core_ext.rb
+- lib/mimi/core/inheritable_property.rb
+- lib/mimi/core/manifest.rb
 - lib/mimi/core/module.rb
 - lib/mimi/core/rake.rb
 - lib/mimi/core/version.rb
@@ -138,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Core module for mimi, microframework for microservices