administrate-field-enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 552eaed63c3ac297836a314cf835091058abb5ad
+  data.tar.gz: a5b8d9e556869c7d48223b5d2946d7fac2c5db3a
+SHA512:
+  metadata.gz: 0bb7384969d4663968c6af1853133543673cd65dd6b45a25dadfc3dcb92bd44cbbbb5e16cb2211ba922dcabd02c6624215aa17d0a59d46505d10030bfa11a2be
+  data.tar.gz: d6137138e083334a5cd3ca14fb2eddcfdf5ea4ee4a805db11b3053e162b3108bd5b855e50a0d2e37869b297f4e013985c0f0740d558795c9baa88b85ed970b0b

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# gem 'administrate', '>= 0.2.2', '< 0.3.0'
+# gem 'rails', '>= 4.0', '< 5.1'
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 DisruptiveAngels
+
+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,33 @@
+# Administrate::Field::Enum
+
+A plugin to show enum attributes in [Administrate].
+
+This repository is the first field plugin extracted out of Administrate.
+Although its structure may change,
+it's designed to act as a template for other Administrate field plugins.
+
+## FAQs
+
+**Q: How should I name my gem?**
+
+A: Administrate field gems must be named according to the [Rubygems naming guidelines].
+
+Essentially, name your gem after the field class that it defines.
+If there's a namespace in the class name, that gets translated to a dash (`-`) in the gem name.
+If the class name is CamelCased, that translates to an underscore (`_`) in the gem name.
+
+Since all administrate field gems are under the namespace `Administrate::Field`,
+every field gem name should start with the prefix `administrate-field-`.
+
+Here are some examples (these don't correspond to actual gems):
+
+| Gem Name | Field Name |
+|----------------------------|------------------------------|
+| `administrate-field-enum` | `Administrate::Field::Enum` |
+| `administrate-field-file_upload` | `Administrate::Field::FileUpload` |
+| `administrate-field-geocoding-region` | `Administrate::Field::Geocoding::Region` |
+| `administrate-field-geocoding-geo_json` | `Administrate::Field::Geocoding::GeoJson` |
+
+[Rubygems naming guidelines]: http://guides.rubygems.org/name-your-gem/
+
+[Administrate]: https://github.com/thoughtbot/administrate

data/administrate-field-enum.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'administrate/field/enum'
+
+Gem::Specification.new do |s|
+  s.name = 'administrate-field-enum'
+  s.version = Administrate::Field::Enum::VERSION
+  s.authors = ['Balbina Santana']
+  s.email = ['balbina@disruptiveangels.com']
+  s.homepage = 'https://github.com/DisruptiveAngels/administrate_field_enum'
+  s.summary = 'Enum field plugin for Administrate'
+  s.description = s.summary
+  s.license = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency 'administrate', '>= 0.2.2', '< 0.3.0'
+  s.add_dependency 'rails', '>= 4.0', '< 5.1'
+end

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

@@ -0,0 +1,28 @@
+<%#
+# Enum Form Partial
+
+This partial renders an input element for enum attributes.
+By default, the input is a select field for the enum attributes.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::Enum][1].
+  A wrapper around the enum attributes pulled from the model.
+
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.select(
+  field.attribute,
+  options_for_select(
+  f.object.class.public_send(field.attribute.to_s.pluralize)
+  .map { |k, v| [k.humanize, k] },
+  f.object.public_send(field.attribute.to_s)),
+  include_blank: false) %>
+</div>

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

@@ -0,0 +1,17 @@
+<%#
+# Enum Index Partial
+
+This partial renders an enum attribute
+to be displayed on a resource's index page.
+
+By default, the attribute is rendered as a text tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Enum][1].
+  A wrapper around the enum attributes pulled from the model.
+
+%>
+
+<%= field.to_s %>

data/app/views/fields/enum/_show.html.erb

@@ -0,0 +1,17 @@
+<%#
+# Enum Show Partial
+
+This partial renders an enum attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered as a text tag.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Enum][1].
+  A wrapper around the enum attributes pulled from the model.
+
+%>
+
+<%= field.to_s %>

data/lib/administrate/field/enum.rb

@@ -0,0 +1,13 @@
+require 'administrate/field/base'
+require 'rails'
+
+module Administrate
+  module Field
+    class Enum < Administrate::Field::Base
+      VERSION = '0.0.1'
+
+      class Engine < ::Rails::Engine
+      end
+    end
+  end
+end

data/spec/lib/administrate/field/enum_spec.rb

@@ -0,0 +1,14 @@
+require 'administrate/field/enum'
+
+describe Administrate::Field::Enum do
+  describe '#to_partial_path' do
+    it 'returns a partial based on the page being rendered' do
+      page = :show
+      field = Administrate::Field::Enum.new(:status, 'status', page)
+
+      path = field.to_partial_path
+
+      expect(path).to eq('/fields/enum/#{page}')
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: administrate-field-enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Balbina Santana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: administrate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Enum field plugin for Administrate
+email:
+- balbina@disruptiveangels.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- administrate-field-enum.gemspec
+- app/views/fields/enum/_form.html.erb
+- app/views/fields/enum/_index.html.erb
+- app/views/fields/enum/_show.html.erb
+- lib/administrate/field/enum.rb
+- spec/lib/administrate/field/enum_spec.rb
+homepage: https://github.com/DisruptiveAngels/administrate_field_enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Enum field plugin for Administrate
+test_files:
+- spec/lib/administrate/field/enum_spec.rb