make-private 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/test.sqlite3

data/.rspec

@@ -0,0 +1,2 @@
+--profile
+--drb

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in make_private.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,20 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'spork' do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch(/^.+\.gemspec/)
+  watch('spec/spec_helper.rb')
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/models/.+\.rb}) {"spec"}
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,88 @@
+# make-private
+
+
+make-private is an ActiveRecord extension that will make all your active record properties private and give you control over what is private and what should be public.
+
+# Why make-private
+
+By default active record makes all properties and associations public which does make it faster to develop with but breaks encapsulation by default. make-private has been developed to bring back encapsulation to active record model.
+
+
+## Status
+_make-private_ is currently in development
+
+## Example
+
+To use make-private private you simply have to include the module in your model, simple.
+
+```ruby
+require 'make-private'
+
+class BusinessModel < ActiveRecord::Base
+  #a_property: string
+  include MakePrivate
+
+end
+
+business_model = BusinessModel.new
+business_model.a_property # This will throw a NoMethodError exception
+```
+
+Properties can be set as normal from within the model
+
+```ruby
+require 'make-private'
+
+class BusinessModel < ActiveRecord::Base
+  #a_property: string
+  include MakePrivate
+
+  def do_something_useful parameter
+    ##some logic
+    self.a_property = parameter
+  end
+
+end
+
+```
+
+If you require to make a property publicly readable set the method to public
+
+```ruby
+require 'make-private'
+
+class BusinessModel < ActiveRecord::Base
+  #a_property: string
+  include MakePrivate
+
+  public :a_property
+end
+
+business_model = BusinessModel.new
+business_model.a_property # This will no longer throw a NoMethodError exception
+business_model.a_property = "something interesting" # This will still throw a NoMethodError exception
+```
+
+Similarly if you really really really need to make the property setter public.
+
+```ruby
+require 'make-private'
+
+class BusinessModel < ActiveRecord::Base
+  #a_property: string
+  include MakePrivate
+
+  public :a_property, :a_property=
+end
+
+business_model = BusinessModel.new
+business_model.a_property # This will no longer throw a NoMethodError exception
+business_model.a_property = "something interesting" # This will not throw a NoMethodError exception
+```
+
+##Notes
+
+Please send any questions, comments or feedback to pythonandchips{at}gmail.com.
+
+Cheers
+Colin

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+require 'active_record'
+require 'yaml'
+require 'logger'
+
+ROOT = "#{File.dirname(__FILE__)}" unless defined?(ROOT)
+
+namespace :db do
+  desc "Migrate the database"
+  task(:migrate) do
+    db_config = YAML::load(File.open('db.yml'))['test']
+    ActiveRecord::Base.establish_connection(db_config)
+    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    migration_folder = ROOT << "/spec/migrations/"
+    puts migration_folder
+    migrations_directory = (migration_folder)
+    ActiveRecord::Migrator.migrate(migrations_directory)
+  end
+end
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/db.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: spec/test.sqlite3
+  pool: 5
+  timeout: 5000

data/lib/make_private.rb

@@ -0,0 +1,48 @@
+require "make_private/version"
+require "make_private/active_record_persistence"
+
+module MakePrivate
+  def self.included(klass)
+    klass.class_eval do
+      self.columns.each do |column|
+        self.instance_eval do
+          define_method(:"#{column.name}=") do |val|
+            write_attribute column.name.to_sym, val
+          end
+
+          define_method(:"#{column.name}") do
+            self[column.name.to_sym]
+          end
+          private :"#{column.name}=", column.name.to_sym
+        end
+      end
+
+      class << self
+        alias :__belongs_to_public :belongs_to
+        alias :__has_one_public :has_one
+        alias :__has_many_public :has_many
+        alias :__has_and_belongs_to_many_public :has_and_belongs_to_many
+
+        def belongs_to *args, &block
+          __belongs_to_public *args, &block
+          private args[0], :"#{args[0]}="
+        end
+
+        def has_one *args, &block
+          __has_one_public *args, &block
+          private args[0], :"#{args[0]}="
+        end
+
+        def has_many *args, &block
+          __has_many_public *args, &block
+          private args[0], :"#{args[0]}="
+        end
+
+        def has_and_belongs_to_many *args, &block
+          __has_and_belongs_to_many_public *args, &block
+          private args[0], :"#{args[0]}="
+        end
+      end
+    end
+  end
+end

data/lib/make_private/active_record_persistence.rb

@@ -0,0 +1,21 @@
+require "active_record/persistence"
+module ActiveRecord
+  module Persistence
+
+    private
+
+    def create
+      attributes_values = arel_attributes_values(!id.nil?)
+
+      new_id = self.class.unscoped.insert attributes_values
+      if self.class.primary_key
+        id ||= new_id
+        self.send(:id=, id)
+      end
+
+      IdentityMap.add(self) if IdentityMap.enabled?
+      @new_record = false
+      id
+    end
+  end
+end

data/lib/make_private/version.rb

@@ -0,0 +1,3 @@
+module MakePrivate
+  VERSION = "0.0.1"
+end

data/skratch.rb

@@ -0,0 +1,15 @@
+class DoSomething
+
+  def call_method
+    self.hello = "world"
+  end
+
+  private
+
+  def hello= val
+    puts "equal method called #{val}"
+  end
+end
+
+do_something = DoSomething.new
+do_something.call_method

data/spec/lib/make_private_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+describe MakePrivate do
+
+  context "a class that has a belongs to association" do
+    Given(:foo){Foo.new}
+    Then do
+      lambda {
+        foo.bar
+      }.should raise_error(NoMethodError)
+    end
+  end
+  context "a class that has a has one association" do
+    Given(:foo){Foo.new}
+    Then do
+      lambda {
+        foo.qux
+      }.should raise_error(NoMethodError)
+    end
+  end
+  context "a class that has a has many association" do
+    Given(:foo){Foo.new}
+    Then do
+      lambda {
+        foo.quux
+      }.should raise_error(NoMethodError)
+    end
+  end
+  context "a class that has a has and belongs to may association" do
+    Given(:foo){Foo.new}
+    Then do
+      lambda {
+        foo.corge
+      }.should raise_error(NoMethodError)
+    end
+  end
+
+  context "with properties" do
+    Then do
+      lambda {
+        foo = Foo.new
+        foo.a_prop = "blah"
+      }.should raise_error(NoMethodError)
+    end
+
+    context "when setting property from public method" do
+      Given(:value){"hello"}
+      When(:foo) do
+        foo = Foo.new
+        foo.set_property(value)
+        foo
+      end
+      Then{foo.get_property.should eql value}
+    end
+  end
+
+  context "should not affect other classes properties in project" do
+    Given(:qux){Qux.new}
+    Then do
+      lambda {
+        qux.a_prop = "hello"
+      }.should_not raise_error(NoMethodError)
+    end
+  end
+
+  context "should allow record to be save" do
+      Given(:value){"hello"}
+      When(:foo) do
+        foo = Foo.new
+        foo.set_property(value)
+        foo.save
+        Foo.find(foo.send(:id))
+      end
+      Then{foo.get_property.should eql value}
+  end
+
+end

data/spec/migrations/001_test_schema.rb

@@ -0,0 +1,31 @@
+class TestSchema < ActiveRecord::Migration
+  def self.up
+    create_table :foos do |t|
+      t.integer :bar_id
+      t.string  :a_prop
+    end
+
+    create_table :bars do |t|
+      t.string :a_prop
+    end
+
+    create_table :quxs do |t|
+      t.string :a_prop
+      t.integer :foo_id
+    end
+
+    create_table :quuxs do |t|
+      t.integer :foo_id
+    end
+
+    create_table :corges do |t|
+    end
+
+    create_table :foos_corges do |t|
+      t.integer :foo_id
+      t.integer :corge_id
+    end
+
+
+  end
+end

data/spec/models/bar.rb

@@ -0,0 +1,2 @@
+class Bar < ActiveRecord::Base
+end

data/spec/models/corge.rb

@@ -0,0 +1,3 @@
+class Corge < ActiveRecord::Base
+
+end

data/spec/models/foo.rb

@@ -0,0 +1,16 @@
+class Foo < ActiveRecord::Base
+  include MakePrivate
+
+  belongs_to :bar
+  has_one :qux
+  has_many :quux
+  has_and_belongs_to_many :corge
+
+  def set_property value
+    self.a_prop = value
+  end
+
+  def get_property
+    a_prop
+  end
+end

data/spec/models/quux.rb

@@ -0,0 +1,2 @@
+class Quux < ActiveRecord::Base
+end

data/spec/models/qux.rb

@@ -0,0 +1,2 @@
+class Qux < ActiveRecord::Base
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'spork'
+
+Spork.prefork do
+  require "active_record"
+  require "rspec"
+  require "rspec/given"
+  Dir.glob(File.expand_path(File.dirname(__FILE__)) + "/support/**/*.rb").each { |file| require file}
+  db_config = YAML::load(File.open('db.yml'))['test']
+  db_config["database"] = File.expand_path(File.dirname(__FILE__)) + '/../'+ db_config["database"]
+  ActiveRecord::Base.establish_connection(db_config)
+
+
+  RSpec.configuration do |config|
+  end
+
+end
+
+Spork.each_run do
+  require "make_private"
+  Dir.glob(File.expand_path(File.dirname(__FILE__)) + "/models/**/*.rb").each { |file| require file}
+
+end
+
+
+
+
+
+
+

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: make-private
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Colin Gemmell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &73973650 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73973650
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &73973440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73973440
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &73973230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73973230
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &73973020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73973020
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &73972810 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73972810
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: &73972560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0.rc
+  type: :development
+  prerelease: false
+  version_requirements: *73972560
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: &73972350 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73972350
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: &73972120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73972120
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: &73971910 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73971910
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &73971700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73971700
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: &73971490 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *73971490
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &73971280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *73971280
+description: Make all active record properties private
+email:
+- pythonandchips@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- db.yml
+- lib/make_private.rb
+- lib/make_private/active_record_persistence.rb
+- lib/make_private/version.rb
+- skratch.rb
+- spec/lib/make_private_spec.rb
+- spec/migrations/001_test_schema.rb
+- spec/models/bar.rb
+- spec/models/corge.rb
+- spec/models/foo.rb
+- spec/models/quux.rb
+- spec/models/qux.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: make_private
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Make all active record properties private
+test_files: []