anonymous_active_record 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67c1cf60e54b550f21a8bf4b0a8993ec57394dd7
+  data.tar.gz: b09d1d7a820a1a6b4299e42ff66586faface6e38
+SHA512:
+  metadata.gz: 3d9be726ea4534a683a358db0f12fa6b9c1a292fe39536b73fab9d069b128445ae48757f7cfc55e34f4063053067247c00fe5cea402423b4c4570e54972dae21
+  data.tar.gz: 7408bced825d4b3ea3971d9bc9493d166fdb86cf1f52cc652450f6db0b786f14ed756d2c80c7d95b9a9d6912238643874504bdd90c4077e5d521d4e67c1f51b2

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/*.gem
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.boling@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in anonymous_active_record.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Peter Boling & Bolt Threads
+
+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,126 @@
+# AnonymousActiveRecord
+
+This library was 🎩 inspired by 🎩, the [Wolverine project](https://github.com/mcary/wolverine), which [implemented a clever workaround](https://github.com/mcary/wolverine/commit/fa27fa2cc485b2fa83d71b2045ba5a0a069dba75) to the official non-support of [anonymous classes by ActiveRecord](https://github.com/rails/rails/issues/8934).
+
+Warning: Use of this gem is a **security risk**, due to the use of Ruby's `eval`.  It is intended for use in a test suite, or other non-critical environment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'anonymous_active_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anonymous_active_record
+
+## Usage
+
+Require the library in your `spec_helper` or other test suite boot file.
+
+```ruby
+require 'anonymous_active_record'
+```
+
+Let's say you want to write specs for a module, `HasBalloon`, which provides a method `has_balloon?`, and will be mixed into ActiveRecord classes.
+
+```ruby
+module HasBalloon
+  def has_balloon?
+    name == 'Spot' ? true : false # only Spot has a balloon
+  end
+end
+```
+
+This won't work [(really!)](https://github.com/rails/rails/issues/8934):
+
+```ruby
+  let(:ar_with_balloon) do
+    Class.new(ActiveRecord::Base) do
+      attr_accessor :name
+      include HasBalloon
+      def flowery_name
+        "#{b_f}#{name}#{b_f}"
+      end
+      def b_f
+        has_balloon? ? '🎈' : '🌸'
+      end
+    end
+  end
+```
+
+So do this instead:
+
+```ruby
+  let(:ar_with_balloon) do
+    AnonymousActiveRecord.generate(columns: ['name']) do
+      include HasBalloon
+      def flowery_name
+        "#{b_f}#{name}#{b_f}"
+      end
+      def b_f
+        has_balloon? ? '🎈' : '🌸'
+      end
+    end
+  end
+  it 'can test the module' do
+    expect(ar_with_balloon.new(name: 'Spot').flowery_name).to eq('🎈Spot🎈')
+    expect(ar_with_balloon.new(name: 'Not Spot').flowery_name).to eq('🌸Not Spot🌸')
+  end
+```
+
+### Generate Options
+
+```ruby
+AnonymousActiveRecord.generate(
+    table_name: 'a_table_name', 
+        # if table_name is not set klass_basename will be used to derive a unique random table_name
+        # default is a unique random table name
+    klass_basename: 'anons', # is default
+    columns: ['name'], 
+        # default is [], 
+        # meaning class will have ['id', 'created_at', 'updated_at'], as the AR defaults
+    timestamps: true, # is default
+    connection_params: { adapter: 'sqlite3', encoding: 'utf8', database: ':memory:' } # is default
+) do
+   # code which becomes part of the class definition
+end
+```
+
+The block is optional.
+
+### Factory Options
+
+```ruby
+AnonymousActiveRecord.factory(
+    source_data: [{name: 'Phil'}, {name: 'Vickie'}],
+        # Array of hashes, where each hash represents a record that will be created
+    # ... The rest of the options are the same as for generate, see above.
+) do
+  # same as for generate, see above.
+end
+```
+
+The block is optional.
+
+There is also a `factory!` method that will raise if the create fails, accomplished by calling `create!` instead of `create`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/anonymous_active_record. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the AnonymousActiveRecord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pboling/anonymous_active_record/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/anonymous_active_record.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anonymous_active_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'anonymous_active_record'
+  spec.version       = AnonymousActiveRecord::VERSION
+  spec.authors       = ['Peter Boling']
+  spec.email         = ['peter.boling@gmail.com']
+
+  spec.summary       = 'Almost Anonymous ActiveRecord classes'
+  spec.description   = 'Replacement for broken Class.new(ActiveRecord::Base)'
+  spec.homepage      = 'https://github.com/pboling/anonymous_active_record'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.4' # Requirement for Ruby String#capitalize
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug', '~> 9.1'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_dependency 'activerecord', '~> 5.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'anonymous_active_record'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/anonymous_active_record/factory.rb

@@ -0,0 +1,32 @@
+#   Usage:
+#
+#     records = AnonymousActiveRecord.factory(source_data: [{name: 'Bob McGurdy'}], columns: ['name']) do
+#                 def flowery_name
+#                   "🌸#{name}🌸"
+#                 end
+#               end
+#     records.first.flowery_name # => "🌸Bob McGurdy🌸"
+#
+module AnonymousActiveRecord
+  # Factory initializes instances of a pseudo anonymous class in a particular namespace of your choosing.
+  class Factory
+    attr_reader :klass
+
+    def initialize(source_data, klass)
+      @source_data = source_data # an array of hashes
+      @klass = klass
+    end
+
+    def run
+      @source_data.map do |hash|
+        klass.create(hash)
+      end
+    end
+
+    def run!
+      @source_data.map do |hash|
+        klass.create!(hash)
+      end
+    end
+  end
+end

data/lib/anonymous_active_record/generator.rb

@@ -0,0 +1,39 @@
+#   Usage:
+#
+#     klass = AnonymousActiveRecord.generate(columns: ['name']) do
+#               def flowery_name
+#                 "🌸#{name}🌸"
+#               end
+#             end
+#     instance = klass.new(name: 'Darla Charla')
+#     instance.save!
+#     instance.flowery_name # => "🌸Darla Charla🌸"
+#
+module AnonymousActiveRecord
+  # Generator defines a pseudo anonymous class in a particular namespace of your choosing.
+  class Generator
+    DEFAULT_NAME = 'anons'.freeze
+
+    attr_reader :klass_namespaces, :table_name, :klass_name
+
+    def initialize(table_name, klass_namespaces = [], klass_basename = nil)
+      @klass_namespaces = Array(klass_namespaces).map(&:to_s).map {|x| x.gsub(/[^a-z0-9]+/i, '_') }
+      klass_context = [(klass_basename || DEFAULT_NAME).gsub(/[^a-z0-9]+/i, '_').capitalize, SecureRandom.uuid.gsub(/[^a-z0-9]+/i, '_')].join('_')
+      @table_name = (table_name || klass_context).downcase.to_s
+      # String#capitalize is Ruby >= 2.4, https://stackoverflow.com/a/3725154/213191
+      @klass_name = (klass_namespaces << klass_context).join('::')
+    end
+
+    def generate(&block)
+      # Many moons ago, ActiveRecord allowed anonymous classes to be created like:
+      #   Class.new(ActiveRecord::Base)
+      # which was useful for specs, and other use cases.  But it is now explicitly not supported, see
+      #   https://github.com/rails/rails/issues/8934
+      eval "class ::#{klass_name} < ActiveRecord::Base; end"
+      klass = Kernel.const_get(klass_name, true)
+      klass.class_eval(&block) if block_given?
+      klass.table_name = table_name
+      klass
+    end
+  end
+end

data/lib/anonymous_active_record/version.rb

@@ -0,0 +1,3 @@
+module AnonymousActiveRecord
+  VERSION = '0.1.0'.freeze
+end

data/lib/anonymous_active_record.rb

@@ -0,0 +1,80 @@
+require 'active_record'
+
+require 'anonymous_active_record/version'
+require 'anonymous_active_record/generator'
+require 'anonymous_active_record/factory'
+
+# Public API for AnonymousActiveRecord is:
+#
+#   AnonymousActiveRecord.generate -
+#     defines a class, creates the table;
+#     returns the class
+#
+#   Usage:
+#
+#     klass = AnonymousActiveRecord.generate(columns: ['name']) do
+#               def flowery_name
+#                 "🌸#{name}🌸"
+#               end
+#             end
+#     instance = klass.new(name: 'Darla Charla')
+#     instance.save!
+#     instance.flowery_name # => "🌸Darla Charla🌸"
+#
+#   AnonymousActiveRecord.factory -
+#     defines a class, creates the table, creates data;
+#     returns inserted records
+#
+#   Usage:
+#
+#     records = AnonymousActiveRecord.factory(source_data: [{name: 'Bob McGurdy'}], columns: ['name']) do
+#                 def flowery_name
+#                   "🌸#{name}🌸"
+#                 end
+#               end
+#     records.first.flowery_name # => "🌸Bob McGurdy🌸"
+#
+module AnonymousActiveRecord
+  DEFAULT_CONNECTION_PARAMS = {
+      adapter: 'sqlite3',
+      encoding: 'utf8',
+      database: ':memory:'
+  }.freeze
+
+  # Defines a pseudo anonymous class in a particular namespace of your choosing.
+  def generate(table_name: nil, klass_namespaces: [], klass_basename: nil, columns: [], timestamps: true, connection_params: DEFAULT_CONNECTION_PARAMS, &block)
+    gen = AnonymousActiveRecord::Generator.new(table_name, klass_namespaces, klass_basename)
+    klass = gen.generate(&block)
+    connection_params = YAML.load_file(connection_params) if connection_params.is_a?(String)
+    klass.establish_connection(connection_params.dup)
+    klass.connection.create_table gen.table_name do |t|
+      t.column :text, :text
+      columns.each do |col|
+        t.column col, :string
+      end
+      t.timestamps if timestamps
+    end
+    klass
+  end
+
+  # Initializes instances of a pseudo anonymous class in a particular namespace of your choosing.
+  def factory(source_data: [], table_name: nil, klass_namespaces: [], klass_basename: nil, columns: [], timestamps: true, connection_params: DEFAULT_CONNECTION_PARAMS, &block)
+    factory = _factory(source_data: source_data, table_name: table_name, klass_namespaces: klass_namespaces, klass_basename: klass_basename, columns: columns, timestamps: timestamps, connection_params: connection_params, &block)
+    factory.run
+  end
+
+  # Initializes instances of a pseudo anonymous class in a particular namespace of your choosing.
+  def factory!(source_data: [], table_name: nil, klass_namespaces: [], klass_basename: nil, columns: [], timestamps: true, connection_params: DEFAULT_CONNECTION_PARAMS, &block)
+    factory = _factory(source_data: source_data, table_name: table_name, klass_namespaces: klass_namespaces, klass_basename: klass_basename, columns: columns, timestamps: timestamps, connection_params: connection_params, &block)
+    factory.run!
+  end
+
+  private
+
+  def _factory(source_data: [], table_name: nil, klass_namespaces: [], klass_basename: nil, columns: [], timestamps: true, connection_params: DEFAULT_CONNECTION_PARAMS, &block)
+    klass = generate(table_name: table_name, klass_namespaces: klass_namespaces, klass_basename: klass_basename, columns: columns, timestamps: timestamps, connection_params: connection_params, &block)
+    AnonymousActiveRecord::Factory.new(source_data, klass)
+  end
+
+  module_function :generate, :factory, :factory!, :_factory
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: anonymous_active_record
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Boling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+description: Replacement for broken Class.new(ActiveRecord::Base)
+email:
+- peter.boling@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- anonymous_active_record.gemspec
+- bin/console
+- bin/setup
+- lib/anonymous_active_record.rb
+- lib/anonymous_active_record/factory.rb
+- lib/anonymous_active_record/generator.rb
+- lib/anonymous_active_record/version.rb
+homepage: https://github.com/pboling/anonymous_active_record
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Almost Anonymous ActiveRecord classes
+test_files: []