private_field 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f6a0be0db478c3b1906b2bea60ee85bc2cf4e40
+  data.tar.gz: d94ae78c64ac28638ef4bd909b6da456dc9cbb30
+SHA512:
+  metadata.gz: 55d551512ff25dab2d8d488182f757d8dfb25f4fdf493121abe81cc7eebcb49e80790dcc78689924786d7b158663deff19bc36564f1453220d6b7819579383f2
+  data.tar.gz: 9e08cbc40f702e3c25559a520a91bb1639af18af3847c36696652e4d67c4a17c1766c624c6bcb462eca381378f56a4888c99a2f5ca09b4179d55d0ac67a1ad33

data/.gitignore

@@ -0,0 +1,47 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# IntelliJ crap
+.idea/**

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Robert Ingrum
+
+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,35 @@
+# private_field
+Make Rails fields private to avoid those lazy temptations.
+
+## Background
+It's easy to fall into the temptation of modifying model fields in random places (like your views),
+but this just makes the world worse.  In most cases, it's a better idea to define a method within 
+your model or a service class that's responsible for handling all of your data manipulation.
+
+This gem enforces that rule by allowing for private field definitions.
+
+Now you may be thinking, "That's already possible, just override the accessors."  And you'd be right,
+but I'm lazy and think that writing:
+ ```ruby
+ private_field :id
+ ```
+is easier than writing:
+```ruby
+field :id
+private attr_accessor :id
+```
+
+## Config
+This is the best (or worst) part: there's no config because I wrote this for one specific use case and
+don't feel like writing config stuff that I won't use.  Feel free to submit a pr if it doesn't suit
+your needs.
+
+All this was written for Mongoid (I'm sorry), so it may take a bit of tweaking to make work for other
+ORMs.
+
+## How to
+Just do `private_field :field_name` instead of `field :field_name`.  If you're feeling feisty, you can
+do `readable_field :field_name` to make the reader public and the writer private.
+
+MAKE SURE THAT YOU DO `include Mongoid::Document` OR WHATEVER ORM YOU'RE USING THIS ISN'T A REPLACEMENT
+FOR THAT CRAP.

data/lib/private_field.rb

@@ -0,0 +1,10 @@
+require 'private_field/version'
+
+module PrivateField
+  require 'private_field/privatizer'
+
+  def self.included(base)
+    base.extend PrivateField::Privatizer
+  end
+end
+

data/lib/private_field/privatizer.rb

@@ -0,0 +1,32 @@
+require 'private_field'
+
+module PrivateField
+  module Privatizer
+    def private_field(name, options = {})
+      field              name, options
+      override_accessors name
+    end
+
+    def readable_field(name, options = {})
+      field            name, options
+      override_writers name
+    end
+
+    private
+
+    def override_accessors(name)
+      override_readers name
+      override_writers name
+    end
+
+    def override_readers(name)
+      private :"#{name}"
+      private :"#{name}_before_type_cast"
+      private :"#{name}?"
+    end
+
+    def override_writers(name)
+      private :"#{name}="
+    end
+  end
+end

data/lib/private_field/version.rb

@@ -0,0 +1,3 @@
+module PrivateField
+  VERSION = '0.0.1'
+end

data/private_field.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'private_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'private_field'
+  spec.version     = PrivateField::VERSION
+  spec.date        = '2018-04-16'
+  spec.summary     = 'Make Rails fields private to avoid those lazy temptations.'
+  spec.description = 'I\'m honestly not sure what the difference between '\
+                  'a summary and description is but this one\'s longer.'
+  spec.authors     = ['Robert Ingrum']
+  spec.email       = 'robert@forustheliving.com'
+  spec.homepage    = 'http://rubygems.org/gems/private_field'
+  spec.license     = 'MIT'
+
+  spec.files       = `git ls-files`.split($/)
+
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'mongoid', '~> 3.0'
+  spec.add_development_dependency 'pry',     '~> 1.0'
+end

data/test/private_field_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path("#{File.dirname(__FILE__)}/spec_helper")
+require 'mongoid'
+
+describe PrivateField do
+  class TestModel
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include PrivateField
+
+    field          :public_field,   type: Boolean
+    private_field  :private_field,  type: Boolean
+    readable_field :readable_field, type: Boolean
+
+    def test_readability(field_name)
+      method(field_name).call
+    end
+
+    def test_writeability(field_name, value)
+      method("#{field_name}=").call(value)
+    end
+  end
+
+  let(:target) { TestModel.new }
+
+  describe 'background' do
+    it 'should allow me to read the standard field' do
+      expect(target.field).to be_nil
+    end
+  end
+
+  describe '.private_field' do
+
+  end
+
+  describe '.readable_field' do
+
+  end
+end

data/test/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'private_field'
+require 'rspec'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: private_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Ingrum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: I'm honestly not sure what the difference between a summary and description
+  is but this one's longer.
+email: robert@forustheliving.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/private_field.rb
+- lib/private_field/privatizer.rb
+- lib/private_field/version.rb
+- private_field.gemspec
+- test/private_field_spec.rb
+- test/spec_helper.rb
+homepage: http://rubygems.org/gems/private_field
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Make Rails fields private to avoid those lazy temptations.
+test_files: []