expandable 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87e9485895ba6a82a0899a9f5a44dcd1e5a33a5c
-  data.tar.gz: 827595dee0cc4c2c28fcd82bcecf3fd54a45a28e
+  metadata.gz: 6e6fd53b6eb1b89afec9909f47c5d296dcdc69dc
+  data.tar.gz: aa8354b5f8886d1f99f7af0434200823d7901bab
 SHA512:
-  metadata.gz: ead7c1ab2fd059ba9ae71188ef933f6486a706041e1e07b223a755bb51eaddaeaaf450bfaf51f27f9fb8fc7786853a47d50283ca4106b6a729cee8bb8f2ff3b3
-  data.tar.gz: 9c33e5fdf8ddd747d7e609982f2284b9a224fbd705adbd9a7a247da7fe8ee027abd982ee020ac75ab200673cbf2df9743201dc07d463e493de55fc98c6c5eb1b
+  metadata.gz: 54008a342d9bce8abed407b02a309a4f184dc748e701b62dbc8269df215fb2a71f201f213fb9c02fc4fbfce2658d74d8a3475a380750e6e087c8e9e53ea56af5
+  data.tar.gz: f0669754613e25e132f6632d9ccee1ce2ac13654245b9177029001e31036ec026d6e1192de8c59b2e6bae6d7bfabafae4879edbd1edd841f5c877bbc67fa5056

data/README.md

@@ -1,8 +1,11 @@
 # Expandable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/expandable`. To experiment with that code, run `bin/console` for an interactive prompt.
+Expandable is a Rails gem that allows you to take that big ugly model codes and
+break it up into many small chunks of organized codes in different files. 
 
-TODO: Delete this and the text above, and describe your gem
+It also helps you to break large business logic in controllers in to little 
+pirces. Usually you want to have the business logic out of the controller and
+in to the model however there are rare times when you just simply can not.
 
 ## Installation
 
@@ -16,26 +19,89 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Setup
 
-    $ gem install expandable
+The first step is to make sure that this folder exist `app/models/expandables`.
+You can either create the file yourself of run the generator:
+
+```bash
+rails generate expandable:init
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem is very easy to use in just three steps. 
+
+##### First 
+Create a folder in `app/models/expandables` where the name of the 
+folder is the model name. For an example the book model
+will be `app/models/expandables/book`.
 
-## Development
+##### Second 
+Create a file with any name and make sure that then end of the file
+name ends with the underscore model name and the extension. For an example 
+the book model will have an expandable in 
+`app/models/expandables/book/foo_book.rb`. 
+ 
+##### Third
+Make sure that the file is a module type. For example the foo_book.rb
+will the the structure:
+
+```ruby
+module FooBook
+  def foo
+    'bar'
+  end
+end
+```
+ 
+Now all you have to do is just use it. Here is an example:
+
+```ruby
+Book.new.foo
+'bar'
+```
 
-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.
+The same principle applys to controllers as well.
 
-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).
+### Class Methods
+
+If you like to make an expandable in to a class method then all you have to do 
+is chnge the file name and module name by adding a self_ infront of it. For
+ an example for book model it will be 
+ `app/models/expandables/book/self_foo_book.rb`.
+ 
+The codes will look like this:
+
+```ruby
+module SelfFooBook
+  def bar
+    'foo'
+  end
+end
+```
+
+Now all you have to do is:
+
+```ruby
+Book.bar
+'foo'
+```
 
-## Contributing
+Simple right? Now start organizing your codes and make your application shine.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/expandable.
+## Limitations
 
+The gem has few limitations such as:
 
-## License
+##### Only one model can use its counter parts. 
+You can not have another model load book's modules. 
+This is done purposely to stop the clutter. 
+If you have a module that needs to be loaded in two or more models then use
+"concerns" and include the modules in each models that needs it.
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+##### Restart Or Reload Needed On Change
+Dispite my best effort I was unable to have the module auto reload on change.
+This means every time you make a change to the modules it will not load unless
+you close and start the application again. 
 

data/config/initializers/expandable.rb

@@ -1,3 +1,7 @@
 unless File.exist?('app/models/expandables')
   Dir.mkdir 'app/models/expandables'
 end
+
+unless File.exist?('app/controllers/expandables')
+  Dir.mkdir 'app/controllers/expandables'
+end

data/expandable.gemspec

@@ -9,10 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Saimon Lovell']
   spec.email         = ['staysynchronize@gmail.com']
 
-  spec.summary       = %q{Expands models to allow more business logic.}
-  spec.description   = %q{Expandables allows you to create instance methods and and class methods and organize them in folders.}
+  spec.summary       = %q{Expands models and controllers to allow you to
+                          organize you codes.}
+  spec.description   = %q{Expandables allows you to create instance methods and
+                          and class methods and organize them in folders.}
   spec.homepage      = 'https://github.com/SaimonL/expandable'
-  spec.license       = 'GNU'
+  spec.license       = 'GNU3'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

data/lib/expandable.rb

@@ -7,7 +7,18 @@ module Expandable
     include LoadModules
 
     config.after_initialize do
-      start_post_load
+      if Rails.env.development?
+        puts ''
+        puts 'Expandable loading ...'
+      end
+
+      start_model_load
+      start_controller_load
+      if Rails.env.development?
+        puts ''
+        puts 'Expandable has loaded'
+        puts ''
+      end
     end
 
   end

data/lib/expandable/application.rb

@@ -3,5 +3,9 @@ module Expandable
     config.paths.add Rails.root.join('app', 'models', 'expandables').to_s,
                      eager_load: true,
                      glob: '*'
+
+    config.paths.add Rails.root.join('app', 'controllers', 'expandables').to_s,
+                     eager_load: true,
+                     glob: '*'
   end
 end

data/lib/expandable/load_modules.rb

@@ -1,30 +1,76 @@
 module LoadModules
-  def start_post_load
-    return unless File.exist?('app/models/expandables')
-    expandables = Dir['app/models/expandables/**/*.rb']
-
-    unless expandables.empty?
-      expandables.each do |modu|
-        modu = File.basename(modu).split('.')[0..-2].join
-        parts = modu.split('_')
-
-        if parts.length > 1
-          target_class = parts[-1].capitalize.classify.safe_constantize
-          expand_module = modu.camelize.classify.safe_constantize
-          load_expandables(target_class, expand_module, parts[0].downcase == 'self')
-        else
-          next
+  def start_model_load
+    load_modules('app/models/expandables')
+  end
+
+  def start_controller_load
+    load_modules('app/controllers/expandables', false)
+  end
+
+  private
+    def load_modules(path, is_model = true)
+      return unless File.exist?(path)
+      expandables = Dir["#{path}/**/*.rb"]
+
+      unless expandables.empty?
+        expandables.each do |modu|
+          if Rails.env.development?
+            puts ''
+            puts '  Found expandable file: ' + modu
+          end
+
+          modu = File.basename(modu).split('.')[0..-2].join
+          parts = modu.split('_')
+
+          if parts.length > 1
+            if is_model
+              target_class = parts[-1]
+                               .singularize
+                               .capitalize
+                               .classify
+                               .safe_constantize
+
+              if Rails.env.development?
+                puts '    Target Model: ' + target_class.to_s
+                puts '    Target Object Type: ' + target_class.class.name
+              end
+            else
+              target_class = [parts[-2].pluralize, parts[-1]].join('_')
+                               .capitalize
+                               .classify
+                               .safe_constantize
+
+              if Rails.env.development?
+                puts '    Target Controller: ' + target_class.to_s
+                puts '    Target Object Type: ' + target_class.class.name
+              end
+            end
+
+            expand_module = modu.camelize.classify.safe_constantize
+            load_expandables(target_class, expand_module, parts[0].downcase == 'self')
+          else
+            if Rails.env.development?
+              puts '    The file was not named properly: ' + modu
+            end
+            next
+          end
         end
       end
     end
-  end
 
-  private
     def load_expandables(target_class, target_module, is_extend)
       if (target_class.class == Class) && (target_module.class == Module)
+        ActiveSupport::Dependencies.explicitly_unloadable_constants << target_module
+
         if is_extend
+          if Rails.env.development?
+            puts '    Loading class module: ' + target_module.to_s
+          end
           target_class.send :extend, target_module
         else
+          if Rails.env.development?
+            puts '    Loading instance module: ' + target_module.to_s
+          end
           target_class.send :include, target_module
         end
       end

data/lib/expandable/version.rb

@@ -1,3 +1,3 @@
 module Expandable
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/generators/expandable/init_generator.rb

@@ -7,15 +7,20 @@ module Expandable
       source_root File.expand_path('..', __FILE__)
 
       def create_structures
-        base_path = 'app/models/expandables'
-        if File.exists?(base_path)
-          puts 'Directory "' + base_path + '" already exist.'
-        else
-          Dir.mkdir(base_path)
-          FileUtils.touch [base_path, '.keep'].join('/')
-          puts 'Directory created: ' + base_path
-        end
+        create_path('app/models/expandables')
+        create_path('app/controllers/expandables')
       end
+
+      private
+        def create_path(base_path)
+          if File.exists?(base_path)
+            puts 'Directory "' + base_path + '" already exist.'
+          else
+            Dir.mkdir(base_path)
+            FileUtils.touch [base_path, '.keep'].join('/')
+            puts 'Directory created: ' + base_path
+          end
+        end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expandable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Saimon Lovell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,8 +38,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Expandables allows you to create instance methods and and class methods
-  and organize them in folders.
+description: |-
+  Expandables allows you to create instance methods and
+                            and class methods and organize them in folders.
 email:
 - staysynchronize@gmail.com
 executables: []
@@ -63,7 +64,7 @@ files:
 - lib/generators/expandable/init_generator.rb
 homepage: https://github.com/SaimonL/expandable
 licenses:
-- GNU
+- GNU3
 metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: 
@@ -85,5 +86,5 @@ rubyforge_project:
 rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
-summary: Expands models to allow more business logic.
+summary: Expands models and controllers to allow you to organize you codes.
 test_files: []