administrate-field-has_many_with_fields 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a494e09edf468634d11ab409298ab1d543812cd0e9517be2a398491bd4b2ce25
-  data.tar.gz: 1077b6614a81a81cd5403a082960e083de4c1263519ddd9845e8abcdb83ae966
+  metadata.gz: 3d49fef5b3d0f3a3d6ba60dd9193f86810cef395ebcafe1ce9bf59784bec6d6d
+  data.tar.gz: c3fa10616982c245a1120805294d9f2029e8c8ee65edcf9ccf971385107be3c0
 SHA512:
-  metadata.gz: 4d584b998f37f0eeccbd089aad7e2dbaac35369594ce475d7b8a981e516ca5958c893060577af82227b3141ecebdb41a7091d4a7311f30e6e39916a18cf66557
-  data.tar.gz: 13fa01d3fce970a945e12bae5f78a9f05e40310dc125f87aa86496723e8c6537144ff643a097c32b9b66f90d7a561198440a95ee7983d9524fccc0b309a844e8
+  metadata.gz: 691bc71229177dc6237d28a7dd0e979e8f4018f1c41abe871e8d475101436f3e7d81ff61ca179b00d36afa99d2913b6d21b137290780bea63bfb657a3f6f2c7d
+  data.tar.gz: 3c56b2fdbeaa5100470a082a7c7d839bcd06f5c5f5afcd479de6af690b7a4117bac41c6da74f15abb6a84eb8a0f1f8938f03de4fdabbb9679eab525eb89cdaca

data/Gemfile

@@ -8,5 +8,3 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
-
-gem "factory_bot"

data/Gemfile.lock

@@ -53,8 +53,6 @@ GEM
     diff-lcs (1.5.0)
     erubi (1.10.0)
     execjs (2.8.1)
-    factory_bot (6.2.1)
-      activesupport (>= 5.0.0)
     ffi (1.15.5)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
@@ -145,7 +143,6 @@ PLATFORMS
 
 DEPENDENCIES
   administrate-field-has_many_with_fields!
-  factory_bot
   rake (~> 13.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,8 +1,6 @@
 # Administrate::Field::HasManyWithFields
 
-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/administrate/field/has_many_with_fields`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An administrate plug-in designed to allow you to only show certain fields when rendering a `has_many` relationship instead of rendering entire collection's dashboard. Extends the `Administrate::Field::HasMany` field.
 
 ## Installation
 
@@ -22,17 +20,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Turn the standard `has_many` relationship in your administrate dashboard from this
 
-## Development
+```ruby
+class UserDashboard < Administrate::BaseDashboard
+  # ATTRIBUTE_TYPES
+  # a hash that describes the type of each of the model's fields.
+  #
+  # Each different type represents an Administrate::Field object,
+  # which determines how the attribute is displayed
+  # on pages throughout the dashboard.
+  ATTRIBUTE_TYPES = {
+    posts: Field::HasMany,
+    # ...
+  }
+```
 
-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.
+into this
 
-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
+class UserDashboard < Administrate::BaseDashboard
+  # ATTRIBUTE_TYPES
+  # a hash that describes the type of each of the model's fields.
+  #
+  # Each different type represents an Administrate::Field object,
+  # which determines how the attribute is displayed
+  # on pages throughout the dashboard.
+  ATTRIBUTE_TYPES = {
+    posts: Field::HasManyWithFields.with_options(fields: [:id, :attr_1, :attr_2, :method_1]),
+    # ...
+  }
+```
 
-## Contributing
+The standard administrate `with_options` method (limit, class_name, etc) still works because this inherits from `Administrate::Field::HasMany`. The `fields` array also works with both model attributes and model methods.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/administrate-field-has_many_with_fields.
 
 ## License
 

data/app/views/fields/has_many_with_fields/_form.html.erb

@@ -0,0 +1,25 @@
+<%#
+# HasMany Form Partial
+This partial renders an input element for has_many relationships.
+By default, the input is a collection select box
+that displays all possible records to associate with.
+The collection select box supports multiple inputs,
+and is augmented with [Selectize].
+## Local variables:
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::HasMany][1].
+  Contains helper methods for displaying a collection select box.
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasMany
+[Selectize]: http://brianreavis.github.io/selectize.js
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.attribute, for: "#{f.object_name}_#{field.attribute_key}" %>
+</div>
+<div class="field-unit__field">
+  <%= f.select(field.attribute_key, nil, {}, multiple: true) do %>
+    <%= options_for_select(field.associated_resource_options, field.selected_options) %>
+  <% end %>
+</div>

data/app/views/fields/has_many_with_fields/_index.html.erb

@@ -0,0 +1,14 @@
+<%#
+# HasMany Index Partial
+This partial renders a has_many relationship,
+to be displayed on a resource's index page.
+By default, the relationship is rendered
+as a count of how many objects are associated through the relationship.
+## Local variables:
+- `field`:
+  An instance of [Administrate::Field::HasMany][1].
+  A wrapper around the has_many relationship pulled from the database.
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasMany
+%>
+
+<%= pluralize(field.data.size, t("activerecord.models.#{field.attribute.to_s.singularize}", default: field.attribute.to_s.humanize.downcase.singularize, count: field.data.size)) %>

data/lib/administrate/field/has_many_with_fields.rb

@@ -1,9 +1,5 @@
-# frozen_string_literal: true
-
 require "administrate/order"
 require "administrate/field/has_many"
-# require_relative "has_many_with_fields/version"
-
 require "administrate/field/base"
 require "rails"
 
@@ -28,45 +24,6 @@ module Administrate
   end
 end
 
-
-
-# module Administrate
-#   module Field
-#     # module HasManyWithFields
-#     class HasManyWithFields < Administrate::Field::HasMany
-#       class Error < StandardError; end
-
-#       def associated_collection(order = self.override_order)
-#         CollectionWithFields.new(
-#           associated_dashboard,
-#           order: order,
-#           fields: options[:fields],
-#         )
-#       end
-
-#       def override_order
-#         @order ||= Administrate::Order.new(sort_by, direction)
-#       end
-#     end
-#   end
-# end
-
-
-
-# class HasManyWithFields < Administrate::Field::HasMany
-#   def associated_collection(order = self.override_order)
-#     CollectionWithFields.new(
-#         associated_dashboard,
-#         order: order,
-#         fields: options[:fields],
-#     )
-#   end
-
-#   def override_order
-#     @order ||= Administrate::Order.new(sort_by, direction)
-#   end
-# end
-
 class CollectionWithFields < Administrate::Page::Collection
   def attributes_for(resource)
     selected_attribute_names.map do |attr_name|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate-field-has_many_with_fields
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Newman
@@ -36,9 +36,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/fields/has_many_with_fields/_form.html.erb
+- app/views/fields/has_many_with_fields/_index.html.erb
 - app/views/fields/has_many_with_fields/_show.html.erb
 - lib/administrate/field/has_many_with_fields.rb
-- lib/administrate/field/has_many_with_fields/version.rb
 homepage: https://github.com/jnewman12/administrate-field-has_many_with_fields
 licenses:
 - MIT

data/lib/administrate/field/has_many_with_fields/version.rb

@@ -1,9 +0,0 @@
-# # frozen_string_literal: true
-
-# module Administrate
-#   module Field
-#     class HasManyWithFields
-#       VERSION = "0.1.0"
-#     end
-#   end
-# end