appsules 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e178965f61a0f02636524119f47b2d087163152
+  data.tar.gz: fafe647871d5dcbc29e6d4ec15b4db05bdfd3459
+SHA512:
+  metadata.gz: 7caef4fb9c7f7973f7a4017dc0004227facb12789a9ee5dd8a2acc01ec0f85be107dfa04c71c9c374f2542af8d91c7e2a3afe8f90b6ecb6adc456888f461dc1f
+  data.tar.gz: a096ba05feb25b266341778c7e6fc3149de91973971987468808a3c031ebac98468aba40e173955d06644a4e0159d307a9ef9bbdbce4934f0f6bb3737f9dd3f9

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,22 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-01-11 14:00:59 -0500 using RuboCop version 0.50.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'appsules.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Metrics/LineLength:
+  Max: 120
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## Version 1.0.0 - January 11, 2018
+* Initial public release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016-2018 PatientsLikeMe
+
+MIT License
+
+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/README.md

@@ -0,0 +1,113 @@
+# Appsules
+
+## Appsules? What the heck?!
+
+Shouldn't your question be: 277 controllers and 440 models, where the heck do I begin?
+
+### Good point. Let me rephrase: Appsules? What the heck?!
+
+Appsules are a different way to organize your Rails app files.
+
+Rails organizes them by architectural role: models directory, controllers directory, and so forth.
+As the code base grows large it becomes hard to understand which code belongs together.
+
+### So appsules are namespaces.
+
+No.  It's just a directory structure.  There are no additional code constructs or abstractions.
+
+### Ok, I think I get it.  Appsules are like when you organize 30 books by color but after you get 300 books you are forced to organize by subject in order to find a book without losing your mind.
+
+Yes.
+
+### And if you decide you are no longer interested in anthropology, you can just yank out the group of seven anthropology books instead of hunting through all 300.
+
+Yes.
+
+## How do I create a new appsule?
+
+Let's say you want to create a new appsule called blog.  Move blog-related code from `app/` down
+into `appsules/` like this, creating subdirectories as needed:
+
+    appsules/
+      blog/
+        controllers/
+          comments_controller.rb
+          posts_controller.rb
+        models/
+          comment.rb
+          post.rb
+        views/
+          comments/
+            new.html.haml
+            ...
+          posts/
+            index.html.haml
+            new.html.haml
+            ...
+
+Leave blog code not found in `app/` (like migrations and routes) where it is.
+
+Move all related tests and factories into `test/appsules` like so:
+
+    test/
+      appsules/
+        blog/
+          controllers/
+            comments_controller_test.rb
+            posts_controller_test.rb
+          factories/
+            comments.rb
+            posts.rb
+          models/
+            comment_test.rb
+            post_test.rb
+
+## How do I appsulate all the things?
+
+Don't go crazy; you don't need to end up with 100 tiny appsules.  One place to start is
+to identify [bounded contexts](http://martinfowler.com/bliki/BoundedContext.html).
+
+## When should I create a new appsule?
+
+When a part of your app seems separate and cohesive (like an admin section, or a search page)
+then extract it out into an appsule.  You can (and should!) build appsules from scratch; you
+don't have to wait to extract it from existing `app/` code.
+
+## Why wouldn't I use an engine?
+
+Engines are another good way to break out code from a large `app/` directory.  Use an engine if:
+1. You expect to share the code with another application (in which case also make it a local gem).
+2. or you want to have more cleanly separated code (appsules do not enforce any code boundaries).
+
+## How do I install appsules into my Rails app?
+
+Add this to your Gemfile:
+
+    gem 'appsules'
+
+Then, in your `test_helper.rb` file, make sure your appsule factories get loaded:
+
+    FactoryBot.definition_file_paths = ['./factories']  # wherever you keep your factories
+    Appsules.add_factory_bot_paths!                     # add factories defined in appsules
+    FactoryBot.find_definitions
+
+All of the files you put into your appsule will be automagically loaded by Rails.  Also,
+you'll get this cool rake task for free:
+
+    `rake test:appsule:any_appsule_name`
+
+## What else?
+
+This doesn't work with RSpec yet; it assumes minitest.  It also assumes you are using FactoryBot.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new pull request
+
+## Anything else?
+
+Yes.  Leif Erikson was a Cantabrigian.  I have personally seen the historical marker that proves it.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/appsules.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "appsules/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "appsules"
+  spec.version       = Appsules::VERSION
+  spec.license       = "MIT"
+  spec.authors       = ["Wyatt Greene", "Michael Deutsch"]
+  spec.email         = ["mdeutsch@patientslikeme.com"]
+  spec.homepage      = "https://github.com/patientslikeme/appsules"
+
+  spec.summary       = "Appsules are a different way to organize your Rails app files"
+  spec.description   = spec.summary
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", "~> 5.0"
+
+  spec.add_development_dependency "rake"
+end

data/lib/appsules.rb

@@ -0,0 +1,44 @@
+require "rails"
+require "active_support"
+require "active_support/core_ext"
+require "appsules/railtie"
+
+module Appsules
+  def self.add_factory_bot_paths!
+    Dir[File.join(Appsules.test_path, "*")].each do |appsule_path|
+      FactoryBot.definition_file_paths << File.join(appsule_path, "factories")
+    end
+  end
+
+  def self.add_factory_girl_paths!
+    Dir[File.join(Appsules.test_path, "*")].each do |appsule_path|
+      FactoryGirl.definition_file_paths << File.join(appsule_path, "factories")
+    end
+  end
+
+  def self.test_path
+    return @@test_path if defined?(@@test_path)
+    @@test_path = Rails.root.join("test", "appsules")
+    FileUtils.mkdir_p @@test_path
+    @@test_path
+  end
+
+  def self.path
+    return @@path if defined?(@@path)
+    @@path = Rails.root.join("appsules")
+    FileUtils.mkdir_p @@path
+    @@path
+  end
+
+  # for internal use by the appsules gem
+  def self.add_helpers(appsule_path, initializer_context)
+    return unless initializer_context.respond_to?(:helper)
+
+    helpers_dir = File.join(appsule_path, "helpers")
+
+    Dir[File.join(helpers_dir, "**", "*_helper.rb")].map do |helper_path|
+      module_name = helper_path.sub(%r{^#{helpers_dir}/(.+)\.rb}i, '\1').classify
+      initializer_context.instance_eval "helper #{module_name}"
+    end
+  end
+end

data/lib/appsules/railtie.rb

@@ -0,0 +1,31 @@
+require "pathname"
+
+module Appsules
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(__dir__, "tasks", "*.rake")].each { |f| load f }
+      Dir[File.join(Appsules.path, "*", "tasks", "*.rake")].each { |f| load f }
+    end
+
+    # Add each appsule"s immediate subdirectories as eager_load paths
+    initializer "appsules.autoload", before: :set_autoload_paths do |app|
+      appsule_paths = Dir.glob(File.join(Appsules.path, "*/*/"))
+      app.config.autoload_paths += appsule_paths
+      app.config.eager_load_paths += appsule_paths
+    end
+
+    initializer "appsules.autoload_views" do |app|
+      ActiveSupport.on_load :action_controller do
+        Dir[File.join(Appsules.path, "*")].each do |appsule_path|
+          Appsules.add_helpers(appsule_path, self)
+          append_view_path File.join(appsule_path, "views")
+        end
+      end
+    end
+
+    # Add /test/appsules to $LOAD_PATH in the test environment
+    initializer "appsules.tests_load_path" do |app|
+      $LOAD_PATH << Appsules.test_path.to_s if Rails.env.test?
+    end
+  end
+end

data/lib/appsules/tasks/test.rake

@@ -0,0 +1,16 @@
+require "rails/test_unit/runner"
+
+namespace :test do
+  namespace :appsule do
+    Dir[File.join(Appsules.test_path, "*")].each do |appsule_path|
+      appsule_name = appsule_path.split("/").last
+      Rake::Task[:test].enhance { Rake::Task["test:appsule:#{appsule_name}"].invoke }
+
+      desc "run tests for appsule #{appsule_name}"
+      task appsule_name => "test:prepare" do
+        pattern = File.join(appsule_path, "**", "*_test.rb")
+        Rails::TestUnit::Runner.run(Dir.glob(pattern))
+      end
+    end
+  end
+end

data/lib/appsules/version.rb

@@ -0,0 +1,3 @@
+module Appsules
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: appsules
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wyatt Greene
+- Michael Deutsch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Appsules are a different way to organize your Rails app files
+email:
+- mdeutsch@patientslikeme.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appsules.gemspec
+- lib/appsules.rb
+- lib/appsules/railtie.rb
+- lib/appsules/tasks/test.rake
+- lib/appsules/version.rb
+homepage: https://github.com/patientslikeme/appsules
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Appsules are a different way to organize your Rails app files
+test_files: []