meta_presenter 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c82a743718f5aadff23b8c43bfb6890fc95ab2d5eb3d754328b94a2cefab1363
-  data.tar.gz: 91a96f06fcb1daa1a0992e5a2b6cf793b6747728abf5e2d23abc1906fe1f130d
+  metadata.gz: 6472c3bd9362c0382d078e139be49b95313689722ef8ee59eb94dd44bf60964c
+  data.tar.gz: 37fa528ed35baa5910a5da3d2984c6be8cf4a301df3a3549d13254a6dd6411b3
 SHA512:
-  metadata.gz: b573c02a269b12d30c3655ba86218aa1cd8b02b5ef8b65c27edd61984eb197950e21338817a21134a3e1e2673ab24cd47639692c90912ad3d66c86235a14820d
-  data.tar.gz: b841eb0383da7bd3bb9eb750a8421218097717c923b6299d1d71742b7d700100a26b191e32606725d795c23ec13474903e4f579d9bb5fefeff792daa2569c178
+  metadata.gz: ea6ba9139e5bc5286b9023cbfd59ffff1fcee9744fe7dc0e75e0a09c7540e678fbb15193299ab59f71a41bdc9a172f2ee41f71ca490d5c4978aa0a99ecb7fc90
+  data.tar.gz: 87a4ce8737f8d4a01e1d0b0288bd13c11607261c6fa9e106d0ef9f3b403317fb9e55b6d52923fe3e33a37bfe2fee9029e331432a686ade63616721c0f61fef47

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.7.5
+  NewCops: enable
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/.travis.yml

@@ -3,26 +3,20 @@ cache: bundler
 matrix:
   fast_finish: true
 rvm:
-  - 2.1.0
-  - 2.2.0
-  - 2.3.0
-  - 2.4.0
-  - 2.5.0
-  - 2.6.0
+  - 2.7.5
+  - 3.0.0
+  - 3.1.0
+  - 3.2.0
 gemfile:
   - gemfiles/rails3.gemfile
   - gemfiles/rails4.gemfile
   - gemfiles/rails5.gemfile
+  - gemfiles/rails6.gemfile
+  - gemfiles/rails7.gemfile
 matrix:
   exclude:
-    - rvm: 2.1.0
-      gemfile: gemfiles/rails5.gemfile
-    - rvm: 2.2.0
-      gemfile: gemfiles/rails5.gemfile
-    - rvm: 2.5.0
-      gemfile: gemfiles/rails3.gemfile
-    - rvm: 2.6.0
+    - rvm: 2.7.5
       gemfile: gemfiles/rails3.gemfile
 script: bundle exec rspec
 before_install:
-  - gem install bundler -v '< 2'
+  - gem install bundler

data/Appraisals

@@ -1,20 +1,9 @@
-appraise "rails3" do
-  gem "actionpack", "3.0.12"
-  gem "actionmailer", "3.0.12"
+appraise 'rails6' do
+  gem 'actionpack', '6.0.0'
+  gem 'actionmailer', '6.0.0'
 end
 
-appraise "rails4" do
-  gem "actionpack", "4.0.0"
-  gem "actionmailer", "4.0.0"
+appraise 'rails7' do
+  gem 'actionpack', '7.0.1'
+  gem 'actionmailer', '7.0.1'
 end
-
-appraise "rails5" do
-  gem "actionpack", "5.0.0"
-  gem "actionmailer", "5.0.0"
-end
-
-# TODO: uncomment this once Rails 6 is released on April 30, 2019
-# appraise "rails6" do
-#   gem "actionpack", "6.0.0"
-#   gem "actionmailer", "6.0.0"
-# end

data/CHANGELOG.md

@@ -0,0 +1 @@
+* Add Rails 6 support.

data/Gemfile

@@ -5,9 +5,12 @@ gemspec
 # Hinting at development dependencies
 # Prevents bundler from taking a long-time to resolve
 group :development, :test do
-  gem 'pry'
-  gem 'rspec'
   gem 'builder'
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
   gem 'rb-readline'
-  gem 'coveralls'
-end
+  gem 'rspec'
+end
+
+group :development do
+  gem 'rubocop', '~> 1.57', require: false
+end

data/Gemfile.lock

@@ -1,127 +1,195 @@
 PATH
   remote: .
   specs:
-    meta_presenter (0.2.3)
+    meta_presenter (1.0.0)
       actionmailer (>= 3.0.12)
       actionpack (>= 3.0.12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.0)
-      actionpack (= 6.0.0)
-      actionview (= 6.0.0)
-      activejob (= 6.0.0)
+    actionmailer (7.1.1)
+      actionpack (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activesupport (= 7.1.1)
       mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.0)
-      actionview (= 6.0.0)
-      activesupport (= 6.0.0)
-      rack (~> 2.0)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.1)
+      actionview (= 7.1.1)
+      activesupport (= 7.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.0)
-      activesupport (= 6.0.0)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.0)
-      activesupport (= 6.0.0)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
       globalid (>= 0.3.6)
-    activesupport (6.0.0)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    appraisal (2.2.0)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    appraisal (2.5.0)
       bundler
       rake
       thor (>= 0.14.0)
-    builder (3.2.3)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+    ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
       thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    erubi (1.8.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.6.0)
+    crass (1.0.6)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    drb (2.1.1)
+      ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.2.0)
-    loofah (2.2.3)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    loofah (2.21.4)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.2)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.4)
-      mini_portile2 (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.0.7)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+      net-imap
+      net-pop
+      net-smtp
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.4)
+    minitest (5.20.0)
+    mutex_m (0.1.2)
+    net-imap (0.4.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nokogiri (1.15.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.15.4-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.1)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    rake (12.3.3)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.0.6)
     rb-readline (0.5.5)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    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.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.1)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.20.3)
-    thread_safe (0.3.6)
-    tins (1.21.1)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    zeitwerk (2.1.9)
+    thor (1.3.0)
+    timeout (0.4.0)
+    tins (1.32.1)
+      sync
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
 
 DEPENDENCIES
   appraisal
   builder
   bundler
+  byebug
   coveralls
   meta_presenter!
   pry
   rake
   rb-readline
   rspec
+  rubocop (~> 1.57)
 
 BUNDLED WITH
-   1.17.3
+   2.4.21

data/README.md

@@ -8,19 +8,19 @@ MetaPresenter is a Ruby gem for writing highly focused and testable Rails view p
 
 ## Installation
 
-1. Add this line to your application's Gemfile:
+### 1. Add this line to your application's Gemfile
 
 ```ruby
 gem 'meta_presenter'
 ```
 
-2. Bundle from the command line:
+### 2. Bundle from the command line
 
 ```sh
-$ bundle
+bundle install
 ```
 
-3. Include MetaPresenter::Helpers in your controller or mailer:
+### 3. Include MetaPresenter::Helpers in ApplicationController
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -29,157 +29,103 @@ end
 ```
 
 ```ruby
+# mailers are supported too
 class ApplicationMailer < ActionMailer::Base
   include MetaPresenter::Helpers
 end
 ```
 
-## Example
+## Setup
 
-Say you have a PagesController with `#home` and `#logs` actions. Underneath app/presenters you can add a presenter class for each action (Pages::HomePresenter and Pages::LogsPresenter). We'll also create an ApplicationPresenter superclass for methods that can be used in any action throughout the app.
+### 1. Create an ApplicationPresenter
 
-```
-app/
-  controllers/
-    application_controller.rb
-    pages_controller.rb
-  presenters/
-    application_presenter.rb
-    pages_presenter.rb
-    pages/
-      home_presenter.rb
-      logs_presenter.rb
-  views
-    pages
-      home.html.erb
-      logs.html.erb
-spec/ (or test/)
-  presenters/
-    application_presenter_spec.rb
-    pages_presenter_spec.rb
-    pages/
-      home_presenter_spec.rb
-      logs_presenter_spec.rb
-```
-
-app/controllers/page_controller.rb
-
-```ruby
-class ApplicationController < ActionController::Base
-  include MetaPresenter::Helpers
-
-  # Controller methods automatically become available in views and other presenters.
-  # So this gives you presenter.current_user in views, and you can call `current_user`
-  # within your presenters as well
-  def current_user
-    User.first
-  end
-end
-```
-
-app/controllers/dashboard_controller.rb
-
-```ruby
-class ApplicationController < ActionController::Base
-  def home
-  end
-
-  def logs
-  end
-
-  private
-    # presenter.logs in views
-    def logs
-      Log.all
-    end
-end
-```
-
-app/presenters/application_presenter.rb
+ApplicationPresenter methods can be used anywhere in the app. This example makes `presenter.page_title` and `presenter.last_login` accessible from all views.
 
 ```ruby
+# app/presenters/application_presenter.rb
 class ApplicationPresenter < MetaPresenter::BasePresenter
-  # Makes presenter.page_title available in all of your app's views
   def page_title
     "My App"
   end
 
-  # presenter.last_login_at in views
-  def last_login_at
-    # controller methods from within the same scope
-    # as the presenter are directly available
-    current_user.last_login_at
+  def last_login
+    # controller methods are available to
+    # presenters in the same namespace
+    time = current_user.last_login_at
+    distance_of_time_in_words_to_now(time)
   end
 end
 ```
 
-app/presenters/pages_presenter.rb
+#### 2. Create presenters for your controllers
+
+This example makes `presenter.tooltip(text)` available for all actions on `PagesController`:
 
 ```ruby
+# app/presenters/pages_presenter.rb
 class PagesPresenter < ApplicationPresenter
-  # Makes presenter.nav_items available for
-  # all actions on PagesController
-  def nav_items
-    [
-      {name: "Home", path: home_path},
-      {name: "Logs", path: logs_path}
-    ]
+  def tooltip(text)
+    content_tag(:p, text, class: "font-body1")
   end
 end
 ```
 
-app/presenters/pages/home_presenter.rb
+```Erb
+<!-- app/views/pages/about.html.erb -->
+<h1>About</h1>
+<p data-tipsy-content="<%= presenter.tooltip("Don't Be Evil") %>">Gloogle</p>
+```
+
+#### 3. Create presenters for specific actions
+
+This example makes `presenter.greeting` accessible from views. It also delegates undefined methods to `current_user`, so `presenter.email` would call `current_user.email`:
 
 ```ruby
+# app/presenters/pages/home_presenter.rb
 class Pages::HomePresenter < PagesPresenter
-  # presenter.email, presenter.id or any other
-  # method not already defined will delegate to
-  # the current_user
+  # can also delegate specific methods. ex:
+  # delegate :email, :last, to: :current_user
   delegate_all_to = :current_user
 
-  # presenter.greeting in views
   def greeting
-    "Hello, #{current_user.name}"
+    "Hello, #{name}"
   end
 end
 ```
 
-app/views/pages/home.html.erb
-
 ```Erb
+<!-- app/views/pages/home.html.erb -->
 <h1>Home</h1>
 <p><%= presenter.greeting %></p>
-<p>Last login <%= distance_of_time_in_words_to_now(presenter.last_login_at) %></p>
+<p>Last login <%= presenter.last_login %></p>
 ```
 
-app/presenters/pages/logs_presenter.rb
-
-```ruby
-class Pages::LogsPresenter < PagesPresenter
-  # presenter.size and presenter.last will delegate to 
-  # the controller's private `#logs`
-  delegate :size, :last, to: :logs
-
-  # presenter.log_text(log) in view
-  def log_text(log)
-    log.description
-  end
-end
-```
+## Example directory structure
 
-app/views/pages/logs.html.erb
+Note that presenters mirror the namespace of controllers.
 
-```Erb
-<h1>Logs</h1>
-<p>Num logs: #{presenter.size}</p>
-<p>Last log: #{presenter.log_text(presenter.last)}</p>
-<ul>
-  <% presenter.logs.each do |log| %>
-    <li>
-      <%= presenter.log_text(log) %>
-    </li>
-  <% end %>
-</ul>
+```diagram
+app/
+  controllers/
+    application_controller.rb
+    pages_controller.rb
+  presenters/
+    application_presenter.rb
+    pages_presenter.rb
+    pages/
+      home_presenter.rb
+      logs_presenter.rb
+  views
+    pages
+      home.html.erb
+      logs.html.erb
+spec/ (or test/)
+  presenters/
+    application_presenter_spec.rb
+    pages_presenter_spec.rb
+    pages/
+      home_presenter_spec.rb
+      logs_presenter_spec.rb
 ```
 
 ## Aliasing the presenter methods
@@ -197,35 +143,50 @@ end
 
 ## Requirements
 
-MetaPresenter supports Ruby >= 2.1 and ActionPack/ActionMailer >= 3.0.12. If you'd like to help adding support for older versions please submit a pull request with passing specs.
+MetaPresenter supports Ruby >= 2.7.5 and ActionPack/ActionMailer >= 6
 
 ## Links
 
-* [Project website](https://metapresenter.com)
-* [RDocs for the master branch](https://www.rubydoc.info/github/szTheory/meta-presenter/master)
+- [Project website](https://metapresenter.com)
+- [RDocs for the master branch](https://www.rubydoc.info/github/szTheory/meta-presenter/master)
 
 ## Specs
+
 To run the specs for the currently running Ruby version, run `bundle install` and then `bundle exec rspec`. To run specs for every supported version of ActionPack, run `bundle exec appraisal install` and then `bundle exec appraisal rspec`.
 
 ## Gem release
+
 Make sure the specs pass, bump the version number in meta_presenter.gemspec, build the gem with `gem build meta_presenter.gemspec`. Commit your changes and push to Github, then tag the commit with the current release number using Github's Releases interface (use the format vx.x.x, where x is the semantic version number). You can pull the latest tags to your local repo with `git pull --tags`. Finally, push the gem with `gem push meta_presenter-version-number-here.gem`.
 
+## TODO High-Priority
+
+- Add a `rake meta_presenter:install` that generates the scaffolding for you
+- Make sure directions are clear for manually creating presenters
+
 ## TODO
-* create an example app and link to the repo for it in this README
-* proofread the README instructions to make sure everything is correct
-* optional `rake meta_presenter:install` that generates the scaffolding for you. Or, you can manually create the files you want.
-* add support for layout-level presenters
-* add Rails 6 support once it comes out (hopefully just have to add a gemfiles/actionpack6.gemfile and it will run with the Appraisal suite)
+
+- create an example app and link to the repo for it in this README
+- add support for layout-level presenters
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b feature/my-new-feature`) or bugfix branch (`git checkout -b bugfix/my-helpful-bugfix`) 
+2. Create your feature branch (`git checkout -b feature/my-new-feature`) or bugfix branch (`git checkout -b bugfix/my-helpful-bugfix`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin feature/my-new-feature`)
 5. Make sure specs are passing (`bundle exec rspec`)
 6. Create new Pull Request
 
+## Running the specs
+
+To run specs against different versions of Rails:
+
+```bash
+bundle exec appraisal install #install dependencies for each ruby version
+bundle exec appraisal rails6 rspec #run rails 6 specs on current Ruby
+bundle exec appraisal rails7 rspec #run rails 7 specs on current Ruby
+```
+
 ## License
 
 See the [LICENSE](https://github.com/szTheory/meta_presenter/blob/master/LICENSE.txt) file.