appdev_support 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c445a2d99b989fe0a5cb203c3774a6f67a488aade775749c7732fe7211700d5
+  data.tar.gz: 233869e210245da7aef18666cc6852c8fabe6275535605c5498dcbf1a4612a4a
+SHA512:
+  metadata.gz: c20251390cbf6238c0d56f3391b325709966e1df21ec4e09646196658dc9867cdc54823bef46704a986e17d2157c372fb1f9594afd9884feeedc8f20505c97b4
+  data.tar.gz: 87d790e09c409b9c3dce83f7b689ca6bb7bbc6ae77f07580c1bfdfec3fe3e546971e8f9b52c54daa081cba9798ca9a8a54ec1553c10f444030edf4bc99b83689

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_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,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

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 jelani@firstdraft.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in appdev_support.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "tabulo"

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    appdev_support (0.2.1)
+      tabulo
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    tabulo (2.8.2)
+      tty-screen (= 0.8.1)
+      unicode-display_width (~> 2.2)
+    tty-screen (0.8.1)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  appdev_support!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  tabulo
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jelani Woods
+
+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,137 @@
+# AppdevSupport
+
+This gem adds patches that are used to make Ruby and Ruby on Rails environments more beginner friendly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "appdev_support", github: "firstdraft/appdev_support"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install appdev_support
+
+Run
+
+```rb
+AppdevSupport.init
+```
+to load the default settings.
+
+Create an [initializer](#configuration) file for customization.
+
+## Usage
+
+Once installed, you can do things like:
+
+```ruby
+# in app/controllers/events_controller.rb
+class EventsController < ApplicationController 
+  def index
+    cookies.store(:theme, "dark")
+    cookies.fetch(:theme)
+    session.fetch(:user_id)
+  end
+end
+```
+
+and `session.fetch` will raise a `KeyNotFound` Exception.
+
+`.fetch` can be called on `session`, `cookies`, and any `ActiveRecord` object. For an `ActiveRecord` object, you can `.fetch` a column.
+
+```ruby
+Event.fetch(:starts_on) # => "Mon, 23 Mar 2020 23:25:48"
+```
+
+Similarly, `.store` can be called on `session` and `cookies` with the expected behavior. 
+
+```ruby
+session.store(:user_id, 1)
+```
+
+Displaying an `ActiveRecord::Relation` in a View file will display:
+
+```rb
+Event::ActiveRecord_Relation (array with 4 Event instances inside)
+```
+
+You can call `.at` on an `ActiveRecord::Relation` instead of just `[]` to mirror how Arrays work.
+
+```ruby
+Event.all.at(0)
+```
+
+If the containing app has `pry` or `pry-rails` installed, the `print` functionality has been enhanced:
+With the value `:mimimal`:
+- `ActiveRecord::Relation` objects are displayed like this:
+  ```irb
+  pry(main)> Todo.all
+  => Todo::ActiveRecord_Relation (array with 1 Todo instance inside)
+  ```
+With the value `:debug`
+- `ActiveRecord::Relation` objects are displayed like this:
+  ```irb
+  pry(main)> Todo.all
+  Todo Count (0.3ms)  SELECT COUNT(*) FROM "todos"
+  Todo Load (0.2ms)  SELECT "todos".* FROM "todos"
+  +----+-------+------+---------------------------------------------+
+  | id | title | body | {:header_frequency=>10, :border=>:markdown} |
+  +----+-------+------+---------------------------------------------+
+  |  1 | test  | nope |                                             |
+  +----+-------+------+---------------------------------------------+
+
+    Todo Count (0.3ms)  SELECT COUNT(*) FROM "todos"
+  => Todo::ActiveRecord_Relation (array with 1 Todo instance inside)
+  ```
+- `Class` objects are displayed like this:
+  ```irb
+  pry(main)> Todo
+  => Todo(id: integer, title: string, body: text, created_at: datetime, updated_at: datetime)
+
+  The Todo class itself.
+  ```
+- All other objects are displayed like this:
+  ```irb
+  pry(main)> "hello, world"
+  => "hello, world"
+
+  An instance of the String class.
+  ```
+
+## Configuration
+
+Add an initializer:
+
+```rb
+AppdevSupport.config do |config|
+# config.action_dispatch = true
+# config.active_record   = true
+# config.pryrc           = :minimal
+end
+AppdevSupport.init
+```
+
+In a Rails app, this usually means creating a file in the `config/` folder called `appdev_support.rb`
+
+By default, these settings are `true`. Turn any of them off here. Options are currently grouped by highest parent class.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/firstdraft/appdev_support. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/firstdraft/appdev_support/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AppdevSupport project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/firstdraft/appdev_support/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/appdev_support.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/appdev_support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "appdev_support"
+  spec.version       = AppdevSupport::VERSION
+  spec.authors       = ["Jelani Woods"]
+  spec.email         = ["jelani@firstdraft.com"]
+
+  spec.summary       = %q{A gem that ties together the all the Rails monkey patches we use in class.}
+  spec.description   = %q{🙈}
+  spec.homepage      = "https://github.com/firstdraft/appdev_support"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/firstdraft/appdev_support"
+  spec.metadata["changelog_uri"] = "https://github.com/firstdraft/appdev_support"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.add_runtime_dependency(%q<tabulo>.freeze, [">= 0"])
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "appdev_support"
+
+# 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/appdev_support/action_dispatch/cookies/cookie_jar/fetch.rb

@@ -0,0 +1,15 @@
+module ActionDispatch
+  class Cookies
+    class CookieJar
+      def fetch(key, *fallback)
+        if has_key?(key)
+          self.[](key)
+        elsif fallback.present?
+          fallback
+        else
+          raise KeyError, "Key not found. Could not find #{key} in cookies Hash."
+        end
+      end
+    end
+  end
+end

data/lib/appdev_support/action_dispatch/cookies/cookie_jar/store.rb

@@ -0,0 +1,7 @@
+module ActionDispatch
+  class Cookies
+    class CookieJar
+      alias store []=
+    end
+  end
+end

data/lib/appdev_support/action_dispatch/request/session/fetch.rb

@@ -0,0 +1,15 @@
+module ActionDispatch
+  class Request
+    class Session
+      def fetch(key, *fallback)
+        if has_key?(key)
+          self.[](key)
+        elsif fallback.present?
+          fallback
+        else
+          raise KeyError, "Key not found. Could not find #{key} in session Hash."
+        end
+      end
+    end
+  end
+end

data/lib/appdev_support/action_dispatch/request/session/store.rb

@@ -0,0 +1,7 @@
+module ActionDispatch
+  class Request
+    class Session
+      alias store []=
+    end
+  end
+end

data/lib/appdev_support/active_record/attribute_methods.rb

@@ -0,0 +1,6 @@
+module ActiveRecord
+  module AttributeMethods
+    alias fetch []
+    alias store []=
+  end
+end

data/lib/appdev_support/active_record/calculations.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Calculations
+    alias map_relation_to_array pluck
+  end
+end

data/lib/appdev_support/active_record/delegation.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Delegation
+    alias at []
+  end
+end

data/lib/appdev_support/active_record/relation/to_s.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  class Relation
+    def to_s
+      row_count = count
+
+      "#{self.class} (array with #{row_count} #{model} #{"instance".pluralize(row_count)} inside)"
+    end
+  end
+end

data/lib/appdev_support/pryrc/debug.rb

@@ -0,0 +1,49 @@
+require "tabulo"
+Pry.config.print = proc do |output, value, _pry_|
+  case value
+  when ActiveRecord::Relation
+    row_count = value.count
+
+    max_rows_to_display_at_once = 5
+    num_rows_to_frame_with = 2
+    
+    column_names_to_exclude =  [:created_at, :updated_at]
+    column_names = value.column_names.map(&:to_sym) - column_names_to_exclude
+    
+    header_frequency = 10
+    border_style = :markdown
+
+    table_options = {
+      header_frequency: header_frequency,
+      border: border_style,
+      wrap_body_cells_to: 1,
+      truncation_indicator: "…"
+    }
+
+    if row_count > max_rows_to_display_at_once
+      output.puts Tabulo::Table.new(value.limit(num_rows_to_frame_with), *column_names, table_options).pack
+
+      output.puts
+      output.puts "(... #{row_count - 2*num_rows_to_frame_with} more rows between ...)"
+      output.puts
+
+      output.puts Tabulo::Table.new(value.offset(row_count - num_rows_to_frame_with).limit(num_rows_to_frame_with), *column_names, table_options).pack
+    else
+      output.puts Tabulo::Table.new(value, *column_names, table_options).pack
+    end
+
+    output.puts
+    output.puts "=> #{value.to_s}"
+    output.puts
+  when Class
+    Pry::ColorPrinter.default(output, value, _pry_)
+
+    output.puts
+    output.puts("The #{value} class itself.")
+  else
+    Pry::ColorPrinter.default(output, value, _pry_)
+    
+    output.puts
+    output.puts("An instance of the #{value.class} class.")
+  end
+end

data/lib/appdev_support/pryrc/minimal.rb

@@ -0,0 +1,8 @@
+Pry.config.print = proc do |output, value, _pry_|
+  case value
+  when ActiveRecord::Relation
+    output.puts "=> #{value.to_s}"
+  else
+    Pry::ColorPrinter.default(output, value, _pry_)
+  end
+end

data/lib/appdev_support/version.rb

@@ -0,0 +1,3 @@
+module AppdevSupport
+  VERSION = "0.2.1"
+end

data/lib/appdev_support.rb

@@ -0,0 +1,46 @@
+require "appdev_support/version"
+
+module AppdevSupport
+  class Error < StandardError; end
+
+  class << self
+    attr_writer :active_record, :action_dispatch, :pryrc
+
+    def action_dispatch
+      @action_dispatch || true
+    end
+
+    def active_record
+      @active_record || true
+    end
+
+    def pryrc
+      @pryrc || :minimal
+    end
+
+    def config
+      yield self
+    end
+  end
+
+  def self.init
+    if @active_record
+      load "appdev_support/active_record/delegation.rb"
+      load "appdev_support/active_record/attribute_methods.rb"
+      load "appdev_support/active_record/relation/to_s.rb"
+    end
+    if @action_dispatch
+      load "appdev_support/action_dispatch/request/session/fetch.rb"
+      load "appdev_support/action_dispatch/request/session/store.rb"
+      load "appdev_support/action_dispatch/cookies/cookie_jar/fetch.rb"
+      load "appdev_support/action_dispatch/cookies/cookie_jar/store.rb"
+    end
+    return unless Object.const_defined?("Pry")
+    case @pryrc
+    when :minimal, true
+      load "appdev_support/pryrc/minimal.rb"
+    when :debug
+      load "appdev_support/pryrc/debug.rb"
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: appdev_support
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Jelani Woods
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tabulo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\U0001F648"
+email:
+- jelani@firstdraft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- appdev_support.gemspec
+- bin/console
+- bin/setup
+- lib/appdev_support.rb
+- lib/appdev_support/action_dispatch/cookies/cookie_jar/fetch.rb
+- lib/appdev_support/action_dispatch/cookies/cookie_jar/store.rb
+- lib/appdev_support/action_dispatch/request/session/fetch.rb
+- lib/appdev_support/action_dispatch/request/session/store.rb
+- lib/appdev_support/active_record/attribute_methods.rb
+- lib/appdev_support/active_record/calculations.rb
+- lib/appdev_support/active_record/delegation.rb
+- lib/appdev_support/active_record/relation/to_s.rb
+- lib/appdev_support/pryrc/debug.rb
+- lib/appdev_support/pryrc/minimal.rb
+- lib/appdev_support/version.rb
+homepage: https://github.com/firstdraft/appdev_support
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/firstdraft/appdev_support
+  source_code_uri: https://github.com/firstdraft/appdev_support
+  changelog_uri: https://github.com/firstdraft/appdev_support
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: A gem that ties together the all the Rails monkey patches we use in class.
+test_files: []