company_scope 0.7 → 0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79de46e2b5ca59bec724094c5858229a1e336798
-  data.tar.gz: b0f45349ac3462c5d1ebfa495084232e466be606
+  metadata.gz: afc9477877707a43dea45f4700e9bd2901a39709
+  data.tar.gz: d0afae4228b12188111476a736228f03ae26654e
 SHA512:
-  metadata.gz: 61fe3ea5c9f4cb1535cace527c0a9c2cca55fc831ab887f548231b12572ba7f882dffdf9bccfe6191ee7576ef0cabd96798e7f2411bda5ea2690fd4dc72be569
-  data.tar.gz: 4e976917b07f0561e269043b241fc8a16a96bdb5b57df7fa77b6557c0b9d05d1e57cd33050e334c4cdf98f8f9110983bae579ecff03eb2bafc089d61cded1922
+  metadata.gz: 2437b536e02709af7019f4859aaf8aaa253dcf8338ef7aebf906d4148dfaa523d57c84b59d5c3f14d6d777488bc73100d45970697f685308d69fb30d9e688235
+  data.tar.gz: 53f8a2ff5a11fb53f3aa64626517730bbb96b2b858601d3f506963b2868b05346b2bd8ed46674da7569e0130082e82ba330629e8566314ef1986a57c51cdf1b7

data/README.md

@@ -47,7 +47,8 @@ There are three main steps in adding multi-tenancy/company to your app with comp
 The gem has an install generator that adds a configuration setting to config/application.rb
 and also creates two models with associated migrations. The models are company and user.
 The company has the acts_as_guardian company_scope module inserted, and the user has
-the acts_as_company company_scope module inserted.
+the acts_as_company company_scope module inserted. It finally also adds the filtering configuration
+into the Application Controller. (See further below for an explanation)
 
 ```
 rails generate company_scope:install
@@ -72,7 +73,7 @@ to be enabled once the configuration is completed.
 ```
 
 This is deliberately set to false at the outset. Set this to true AFTER all the configuration of
-the gem is completed.
+the gem is completed, i.e. the company model exists and you have run the migration.
 
 ### Process of determining the company/account
 
@@ -182,9 +183,9 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-The above three methods need to be added to the Rails Controllers. For small systems they
-will typically be added to the ApplicationController. However they can be split into
-child-controllers dependent on the layout of the application.
+The above three methods have been added to the Rails Application Controller, by the install
+generator. For small systems they will typically remain there unless you have pages that do
+not require to be scoped by the company in which case they should be added to a child.
 
 All Controllers that inherit from the Controller that implements the acts_as_company_filter
 will have an around filter applied that set the Company class attribute required for the scoping
@@ -238,15 +239,11 @@ class User < ActiveRecord::Base
 end
 ```
 
-### The Gem is currently being used in Rails 4 and Rails-API apps and is tested against Postgres
+#### The Gem is currently being used in Rails 4 and Rails-API apps and is tested against Postgres
 
-### It should work with other databases such as MySQL without any issues
+#### It should work with other databases such as MySQL without any issues
 
-
-## Development
-
-
-## Contributing
+### Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/company_scope/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/company_scope/filter.rb

@@ -32,16 +32,20 @@ module CompanyScope
     module FilterClassMethods
       # - the default is set by the Rails application configuration!
       def set_scoping_class(scope_model = :company)
-        self.class_eval do
-          cattr_accessor :scope_class
+        if CompanyScope.config.enabled
+          self.class_eval do
+            cattr_accessor :scope_class
+          end
+          self.scope_class = scope_model.to_s.camelcase.constantize
         end
-        self.scope_class = scope_model.to_s.camelcase.constantize
       end
       #
       def company_setup
-        helper_method :current_company
-        #set_scoping_class Rails.application.config.company_scope[:company_model]
-        set_scoping_class CompanyScope.config.company_model
+        if CompanyScope.config.enabled
+          helper_method :current_company
+          #set_scoping_class Rails.application.config.company_scope[:company_model]
+          set_scoping_class CompanyScope.config.company_model
+        end
       end
       #
       def acts_as_company_filter

data/lib/company_scope/version.rb

@@ -1,3 +1,3 @@
 module CompanyScope
-  VERSION = "0.7"
+  VERSION = "0.9"
 end

data/lib/generators/company_scope/install_generator.rb

@@ -17,7 +17,7 @@ module CompanyScope
       config_file = 'config/application.rb'
       line = "class Application < Rails::Application"
       insert_config = <<-RUBY
-        config.company_scope[:configured] = false
+      config.company_scope[:configured] = false
       RUBY
       if File.readlines(config_file).grep(/config.company_scope\[:configured\] = false/).size == 0
         gsub_file config_file, /(#{Regexp.escape(line)})/mi do |match|
@@ -37,7 +37,7 @@ module CompanyScope
       unless options.no_migrations?
         # - generate a user model and migration with a company_id reference a few basic user auth fields
         migrate_user_model = <<-RUBY
-          company_id:id
+          company_id:references
           password_hash:string
           password_salt:string
           first_name:string{50}
@@ -57,7 +57,7 @@ module CompanyScope
         insert_guardian_scope = "acts_as_guardian"
         if File.readlines(config_file).grep(/acts_as_guardian/).size == 0
           gsub_file config_file, /(#{Regexp.escape(line)})/mi do |match|
-            match << "\n#{insert_guardian_scope}"
+            match << "\n\t#{insert_guardian_scope}"
           end
         end
       end
@@ -71,10 +71,26 @@ module CompanyScope
         insert_tenant_scope = "acts_as_company"
         if File.readlines(config_file).grep(/acts_as_company/).size == 0
           gsub_file config_file, /(#{Regexp.escape(line)})/mi do |match|
-            match << "\n#{insert_tenant_scope}"
+            match << "\n\t#{insert_tenant_scope}"
           end
         end
       end
     end
+
+    def add_scoping_to_application_controller
+      controller_file = 'app/controllers/application_controller.rb'
+      line = 'class ApplicationController < ActionController::Base'
+      insert_company_scope = <<-RUBY
+      company_setup\n
+      set_scoping_class :company\n
+      acts_as_company_filter\n
+      RUBY
+      if File.readlines(controller_file).grep(/company_setup/).size == 0
+        gsub_file controller_file, /(#{Regexp.escape(line)})/mi do |match|
+          match << "\n#{insert_company_scope}"
+        end
+      end
+    end
+
   end
 end

data/log/test.log

@@ -510,3 +510,51 @@ Processing by DummyApplicationController#index as HTML
 Completed 200 OK in 0ms (Views: 0.2ms)
 Processing by DummyApplicationController#index as HTML
 Completed 500 Internal Server Error in 0ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 3ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 3ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 2ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 2ms
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 1ms (Views: 0.4ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.1ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.2ms)
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 0ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 2ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 3ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 3ms
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 3ms
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.1ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.1ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.1ms)
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 0ms
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.2ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.1ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.1ms)
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 0ms
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.2ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.2ms)
+Processing by DummyApplicationController#index as HTML
+Completed 200 OK in 0ms (Views: 0.2ms)
+Processing by DummyApplicationController#index as HTML
+Completed 500 Internal Server Error in 0ms

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: company_scope
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: '0.9'
 platform: ruby
 authors:
 - Steve Forkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler