recline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8a9590957c1a76c1a8fbd07e33e989e6d62657e
+  data.tar.gz: 71614ece35e0bd3213b25886fb3f2e8e20c01d67
+SHA512:
+  metadata.gz: 9dee9e3d0f625fd9eb532419b52618ff2793d3a2eef07e1b118042f65531054d62f01ac6fa5cdac5fdf8c168f0ef91fffbef680c8242021f1c13fe41c4ddceee
+  data.tar.gz: bfe5da5e83c87a81534158ddac727b4523ab85238509055e2236e3d69829fce00fc154d92e61ccc3362c25e69e60437c6ae58b9dc9b43f4c1acf478801f1e807

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Cole Turner
+
+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,124 @@
+# Recline for Rails
+Seamless form management for React using GraphQL.
+
+**Work in progress.**
+
+## What is this?
+This is a work in progress that is used for exposing data models through GraphQL for the purpose of building seamless forms.
+
+The goal here is to provide an interface between the backend and frontend of web applications to control how form inputs should look and function with reusable components. Furthermore to allow 
+customization by creating extensions to existing field components and foster a collection of these extensions.
+
+
+## How does it work?
+Recline is a layer to provide data-backed instructions for how to display and validate forms for your ActiveRecord and ActiveModel object types. The heart of Recline is within 
+[GraphQL::Rails::ActiveReflection](/colepatrickturner/graphql-rails-activereflection) providing the core schema for reflecting upon models.
+
+This layer augments the core schema to facilitate the display of forms through the set of React Javascript components that will be released under the same name. This is done through what is called 
+`Appearance` types. These component types are responsible for coercing inputs and outputs to the proper formats, and validating input through the reflections provided over GraphQL.
+
+By default, database types are mapped to a set of Appearance types:
+```ruby
+Recline.default_appearance_types = {
+  string: :string,
+  text: :text,
+  integer: :number,
+  float: :number,
+  decimal: :number,
+  boolean: :toggle,
+  date: :date,
+  datetime: :datetime,
+  timestamp: :datetime
+}
+```
+
+Help me explain this better:
+[https://github.com/colepatrickturner/recline.rails/compare](Create a pull request)
+
+# Installation
+To begin, install the gem by adding it to the `Gemfile`:
+
+```ruby
+  gem 'recline'
+```
+
+Add the following line to an object type that you would like to expose:
+
+```ruby
+  implements GraphQL::Rails::ActiveReflection::Model.interface, inherit: true
+```
+
+And that's it! This will add a `_model` field to your object type that will expose any field that can be mapped to an ActiveModel/ActiveRecord attribute.
+
+Example query fragment:
+
+```graphql
+fragment on YourObjectType {
+  _model: ReclineModel {
+    attributes: [ReclineAttribute] {
+      name: String
+      field_name: String
+      appearance: ReclineAppearance
+
+      validators: [ActiveReflectionValidator] {
+        absence: Boolean
+        presence: Boolean
+        uniqueness: Boolean
+        with_format: String
+        without_format: String
+        min_length: Integer
+        max_length: Integer
+        inclusion: [String]
+        exclusion: [String]
+      }
+
+      validate(int: Integer, str: String, float: Float, bool: Boolean): ActiveReflectionValidation {
+        valid: Boolean
+        errors: [String]
+      }
+    }
+  }
+}
+```
+
+There are a few types to be aware of:
+
+- ReclineModel
+- ReclineAttribute
+- ActiveReflectionValidator
+- ActiveReflectionValidation
+
+
+### Via GraphQL::Rails::ActiveReflection
+
+The `_model` field will resolve to whatever type `Schema.resolve_type` returns for that object.
+Only the fields on that type will be exposed as `attributes` - where `name` is the attribute name and `field_name` is the field name that exposed the attribute.
+
+Each of the validators corresponds to the standard Rails validators. Almost all validators for an attribute will be returned, **except those that have the `if` or `unless` conditionals.** This is by design and therefore make note that any conditional validations will have to be performed manually.
+
+There is also the `validate(...)` field with arguments for standard scalar types. Any one of the arguments can be provided, but only one. The result will contain a `valid` boolean and a list of `errors` strings returned from the validators.
+
+In the future all of the `validate(...)` should be chained for a single call.
+
+## Direction
+Motivation for this repo is hand in hand with ActiveReflection - where anything that is model specific will be delegated there and anything that is UI specific will reside here.
+
+# Needs Help
+If you wish to contribute to this project, any pull request is warmly welcomed.
+
+## Todo
+### Rules for complex default types
+- [ ] Dropdown when attribute has inclusion validator and more than three options
+- [ ] Radio when attribute has inclusion validator and less than three options
+### Appearance options
+- [ ] Precision and scale for number types
+- [ ] Date and time format types
+- [ ] Toggle off/on label text
+
+## Meta 
+- [ ] Documentation
+- [ ] Examples
+- [ ] Unit Tests
+
+# Credits
+- Cole Turner ([@colepatrickturner](https://github.com/colepatrickturner))

data/lib/recline/appearance.rb

@@ -0,0 +1,36 @@
+module Recline
+  class Appearance
+    @types = [
+      :none,
+      :string,
+      :text,
+      :markdown,
+      :url,
+      :email,
+      :number,
+      :select,
+      :date,
+      :time,
+      :datetime,
+      :color,
+      :toggle,
+      :range,
+      :tel,
+      :dropdown,
+      :rating,
+      :radio,
+      :checkbox,
+      :location,
+      :media,
+      :link
+    ]
+
+    def self.define_type(input)
+      @types << input.to_sym
+    end
+
+    class << self
+      attr_reader :types
+    end
+  end
+end

data/lib/recline/attribute_reflection.rb

@@ -0,0 +1,13 @@
+class Recline::AttributeReflection < GraphQL::Rails::ActiveReflection::AttributeReflection
+  @schema_name = "ReclineAttribute"
+  attr_accessor :appearance
+
+  def initialize(field, klass, schema)
+    super
+    @appearance = Recline.appearance_for(klass, @name)
+  end
+
+  def primary_key?
+    @klass.primary_key == @name
+  end
+end

data/lib/recline/model.rb

@@ -0,0 +1,30 @@
+module Recline
+  class Model < GraphQL::Rails::ActiveReflection::Model
+    def self.interface
+      @interface ||= GraphQL::InterfaceType.define do
+        name "ReclineInterface"
+        field('_model', Recline::Types::ModelReflectionType, 'Model of attributes for field.') do
+          description('Fetch the content model for the given object.')
+          resolve(Recline::ModelReflection)
+        end
+      end
+    end
+
+    def self.field(**kwargs, &block)
+      # We have to define it fresh each time because
+      # its name will be modified and its description
+      # _may_ be modified.
+      field = GraphQL::Field.define do
+        type(Recline::Model.interface)
+        description('Fetch the content model for the given object.')
+        resolve(Recline::ModelReflection)
+      end
+
+      if kwargs.any? || block
+        field = field.redefine(kwargs, &block)
+      end
+
+      field
+    end
+  end
+end

data/lib/recline/model_reflection.rb

@@ -0,0 +1,13 @@
+class Recline::ModelReflection < GraphQL::Rails::ActiveReflection::ModelReflection
+  @schema_name = "ReclineModel"
+
+  def get_attributes
+    @attributes ||= @type.fields.map { |name, field|
+      # No reflection if it's not a model attribute
+      property = field.property || name
+      if include_property? property
+        Recline::AttributeReflection.new(field, @klass, @schema)
+      end
+    }.compact
+  end
+end

data/lib/recline/railtie.rb

@@ -0,0 +1,7 @@
+module Recline
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      GraphQL::Field.accepts_definitions(recline_appearance: GraphQL::Define.assign_metadata_key(:recline_appearance))
+    end
+  end
+end

data/lib/recline/types/appearance_enum_type.rb

@@ -0,0 +1,8 @@
+require 'recline/appearance'
+
+Recline::Types::AppearanceEnumType = GraphQL::EnumType.define do
+  name "#{Recline.schema_name_prefix}Appearance"
+  Recline::Appearance.types.each do |sym|
+    value(sym.to_s.upcase, sym.to_s.capitalize, value: sym.to_sym)
+  end
+end

data/lib/recline/types/attribute_reflection_type.rb

@@ -0,0 +1,13 @@
+require 'graphql/rails/active_reflection/types/attribute_reflection_type'
+Recline::Types::AttributeReflectionType = GraphQL::Rails::ActiveReflection::Types::AttributeReflectionType.redefine do
+  name "ReclineAttribute"
+  field :appearance, Recline::Types::AppearanceEnumType
+
+  field :read_only, types.Boolean do
+    resolve ->(obj, _args, _ctx) do
+      !obj.primary_key?
+    end
+  end
+end
+
+puts "Recline::Types::AttributeReflectionType = #{Recline::Types::AttributeReflectionType}"

data/lib/recline/types/model_reflection_type.rb

@@ -0,0 +1,5 @@
+require 'graphql/rails/active_reflection/types/model_reflection_type'
+Recline::Types::ModelReflectionType = GraphQL::Rails::ActiveReflection::Types::ModelReflectionType.redefine do
+  name 'ReclineModel'
+  field :attributes, Recline::Types::AttributeReflectionType.to_list_type
+end

data/lib/recline/version.rb

@@ -0,0 +1,3 @@
+module Recline
+  VERSION = '0.0.1'
+end

data/lib/recline.rb

@@ -0,0 +1,49 @@
+require 'graphql'
+
+module Recline
+  def self.appearance_for(klass, name)
+    if klass.respond_to? :recline_appearance
+      klass.recline_appearance(@name)
+    else
+      db_type = klass.type_for_attribute(name.to_s).type
+      if default_appearance_types.key? db_type
+        default_appearance_types[db_type]
+      else
+        fallback_appearance
+      end
+    end
+  end
+
+  class << self
+    @schema_name_prefix = 'Recline'
+    @fallback_appearance = :string
+
+    attr_accessor :schema_name_prefix
+    attr_accessor :fallback_appearance
+    attr_accessor :default_appearance_types
+
+    def default_appearance_types
+      @default_appearance_types ||= {
+        string: :string,
+        text: :text,
+        integer: :number,
+        float: :number,
+        decimal: :number,
+        boolean: :toggle,
+        date: :date,
+        datetime: :datetime,
+        timestamp: :datetime
+      }
+    end
+  end
+end
+
+require 'recline/railtie' if defined?(Rails)
+require 'recline/model'
+require 'recline/attribute_reflection'
+require 'recline/model_reflection'
+require 'recline/appearance'
+require 'recline/types/appearance_enum_type'
+require 'recline/types/attribute_reflection_type'
+require 'recline/types/model_reflection_type'
+require 'recline/appearance'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: recline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cole Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: Keep your frontend forms sane and seamless with your backend
+email: turner.cole@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/recline.rb
+- lib/recline/appearance.rb
+- lib/recline/attribute_reflection.rb
+- lib/recline/model.rb
+- lib/recline/model_reflection.rb
+- lib/recline/railtie.rb
+- lib/recline/types/appearance_enum_type.rb
+- lib/recline/types/attribute_reflection_type.rb
+- lib/recline/types/model_reflection_type.rb
+- lib/recline/version.rb
+homepage: http://rubygems.org/gems/recline
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Seamless form management for React using GraphQL.
+test_files: []