temporary_tables 0.0.3 → 1.0.0.pre.rc.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c43f851f217e3f173721b157cb9d6f08850df57a1c8191fa2774fe5016846fc
-  data.tar.gz: 48bf725f9b6bde13104111609caec90f8f79362029522c13cedb6d29a0db6e60
+  metadata.gz: b076b68e10ebc3f6e5056afcda995811517b45614f9b426bada1858e3a981d4c
+  data.tar.gz: cc5d5f520f59c3d7b500fc7b1471b14e5c69d2c3abdb3922ecf722f78ad6674f
 SHA512:
-  metadata.gz: beaea096078ff40b70010239fc76c9d70de57738ad863f944defc49c8a875051add1e16e9eb711d9c2ae2649b28ecf34318af7e0c80be7ef8fa3ea49bd1b1966
-  data.tar.gz: 13f409529c9b291653d83284e8d7a4919e8895496ac76aee5ff78164fffd1a1a4e055ef8a40e5395e68143143bd69526784825b62e687198811958a16a3dc205
+  metadata.gz: a6c0305a909d90c0306ddc946a04bd39d94b7622c4e9ac96b6b2b152463a7a4be3c29a8097ea054fa4eba281a8a3c91146fcf485e75d41e78e419045071f1ab8
+  data.tar.gz: aca45573a8544c6bfb2467d07e12c6035d7afb76917077b5b67bc3cde4354dd9768422ec7ce6ae2ec3777b8208ca2b912a0187f625fc0a9d7180c443cad8f823

data/README.md

@@ -1,31 +1,131 @@
-# TemporaryTables
+# temporary_tables
 
-TODO: Delete this and the text below, and describe your gem
+[![CI](https://github.com/keygen-sh/temporary_tables/actions/workflows/test.yml/badge.svg)](https://github.com/keygen-sh/temporary_tables/actions)
+[![Gem Version](https://badge.fury.io/rb/temporary_tables.svg)](https://badge.fury.io/rb/temporary_tables)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/temporary_tables`. To experiment with that code, run `bin/console` for an interactive prompt.
+Use `temporary_tables` to create temporary tables and models in RSpec specs,
+rather than create and maintain a dummy Rails application or messy block-level
+constants.
+
+This gem was extracted from [Keygen](https://keygen.sh).
+
+Sponsored by:
+
+<a href="https://keygen.sh?ref=temporary_tables">
+  <div>
+    <img src="https://keygen.sh/images/logo-pill.png" width="200" alt="Keygen">
+  </div>
+</a>
+
+_A fair source software licensing and distribution API._
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'temporary_tables'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ bundle
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ gem install temporary_tables
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### `temporary_table`
+
+To define a temporary table:
+
+```ruby
+describe Example do
+  temporary_table :user do |t|
+    t.string :email
+    t.string :first_name
+    t.string :last_name
+    t.index :email, unique: true
+  end
+
+  it 'should define a table' do
+    expect(ActiveRecord::Base.connection.table_exists?(:user)).to be true
+  end
+end
+```
+
+The full Active Record schema API is available.
+
+### `temporary_model`
+
+To define an Active Record:
+
+```ruby
+describe Example do
+  temporary_model :user do
+    has_many :posts
+  end
 
-## Development
+  it 'should define a record' do
+    expect(const_defined?(:User)).to be true
+  end
+end
+```
 
-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 define an Active Model:
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+describe Example do
+  temporary_model :guest_user, table_name: nil, base_class: nil do
+    include ActiveModel::Model
+  end
+
+  it 'should define a model' do
+    expect(const_defined?(:GuestUser)).to be true
+  end
+end
+```
+
+To define a PORO:
+
+```ruby
+describe Example do
+  temporary_model :null_user, table_name: nil, base_class: nil do
+    # ...
+  end
+
+  it 'should define a PORO' do
+    expect(const_defined?(:NullUser)).to be true
+  end
+end
+```
+
+## Future
+
+Right now, the gem only supports RSpec, but we're open to pull requests that
+extend the functionality to other testing frameworks.
+
+## Supported Rubies
+
+**`temporary_tables` supports Ruby 3.1 and above.** We encourage you to upgrade
+if you're on an older version. Ruby 3 provides a lot of great features, like
+better pattern matching and a new shorthand hash syntax.
+
+## Is it any good?
+
+Yes.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/temporary_tables.
+If you have an idea, or have discovered a bug, please open an issue or create a
+pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/temporary_tables/methods.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module TemporaryTables
+  module Methods
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def temporary_table(name, ...)
+        table_name = name.to_s.pluralize
+
+        before do
+          ActiveRecord::Migration.suppress_messages do
+            ActiveRecord::Migration.create_table(table_name, ...)
+          end
+        end
+
+        after do
+          ActiveRecord::Migration.suppress_messages do
+            ActiveRecord::Migration.drop_table(table_name, if_exists: true)
+          end
+        end
+      end
+
+      def temporary_model(name, table_name: name.to_s.pluralize, base_class: ActiveRecord::Base, &extension)
+        class_name = name.to_s.classify
+
+        before do |example|
+          base_class = base_class.to_s.constantize if base_class in String | Symbol
+          klass      = Class.new *base_class do
+                         define_singleton_method(:table_name) { table_name.to_s } unless table_name.nil?
+                         define_singleton_method(:name)       { class_name }
+                       end
+
+          unless extension.nil?
+            # pass in an example context so that vars can be accessed
+            context = Class.new do
+                        define_method(:respond_to_missing?) do |method_name|
+                          example.instance_exec { respond_to?(method_name) }
+                        end
+
+                        define_method(:method_missing) do |method_name|
+                          example.instance_exec { send(method_name) }
+                        end
+                      end
+
+            klass.module_exec(context.new, &extension)
+          end
+
+          stub_const(class_name, klass)
+        end
+      end
+    end
+  end
+end

data/lib/temporary_tables/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TemporaryTables
-  VERSION = '0.0.3'
+  VERSION = '1.0.0-rc.2'
 end

data/lib/temporary_tables.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'active_record'
+
+require_relative 'temporary_tables/methods'
 require_relative 'temporary_tables/version'
 
-module TemporaryTables
-end
+module TemporaryTables; end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: temporary_tables
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0.pre.rc.2
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 description: Create temporary tables for Rspec tests.
 email:
 - oss@keygen.sh
@@ -51,6 +51,7 @@ files:
 - README.md
 - SECURITY.md
 - lib/temporary_tables.rb
+- lib/temporary_tables/methods.rb
 - lib/temporary_tables/version.rb
 homepage: https://github.com/keygen-sh/temporary_tables
 licenses:
@@ -67,9 +68,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.13
 signing_key: