yuba 0.0.1.pre → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 065c02ba0b6ba7a96764c3557e3f3abad4e2252d
-  data.tar.gz: 13c440a52f8042fcd001d6d1305e233184c8aca2
+  metadata.gz: a0f50e10de1c64847c7dfb2087e0b8ca416ed1d5
+  data.tar.gz: f1d38de018095e4b0651a0c80c842cadb2070e20
 SHA512:
-  metadata.gz: 107fbf7894edb031119725bd8f9844d78e52dbc3fc9f763cc0b60a244f50868b45949b2ffec47847e92a780598ee5af07e0a835adbcc15e339868ded43b275b8
-  data.tar.gz: c9494157393285ba6b41d231ef56338411c890b96711010278053d6fdb00d71a6f4626ff1b564c1ba6bcecfebb3ea89c14e1f943dbdf83d12298ba5dddb33a10
+  metadata.gz: 4e2b3a1cb8b9f0ac254f67d504ddf99ffc47b02d322e7eded4a1475597eb8f6374c08c59e19ec39662dd2446c299973237ec8f46fa8cc6bd62e1d22bdfe57406
+  data.tar.gz: 8673f827dd5ecf5a140bfe8774b92de85bdf20bb9f2ff1feb894dc55f1fb8f7ffd01ea4105e9060d72f26b286650678d74da30739c9b6f36e118ce171b36c0fa

data/README.md

@@ -1,6 +1,13 @@
 # Yuba
 
-This gem is now under construction. It doesn't work now.
+[![Build Status](https://travis-ci.org/willnet/yuba.svg?branch=master)](https://travis-ci.org/willnet/yuba)
+[![Gem Version](https://badge.fury.io/rb/yuba.svg)](https://badge.fury.io/rb/yuba)
+
+## warning
+
+Version of this gem is now 0.0.x. It works but there must be occasional breaking changes to the API.
+
+## Summary
 
 Yuba add new layers to rails.
 
@@ -8,11 +15,12 @@ Yuba add new layers to rails.
 - Form
 - ViewModel
 
-## Usage
+It is convenient to use them in combination, but you can use them even by themselves.
 
-How to use my plugin.
+If you have difficulties with large rails application, Yuba help you.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -20,17 +28,216 @@ gem 'yuba'
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+$ bundle install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install yuba
+## Support
+
+- Rails 4.2+
+- Ruby 2.2+
+
+## ViewModel
+
+ViewModel is useful when there are many instance variables in controller.
+
+```ruby
+class PostViewModel < Yuba::ViewModel
+  property :post
+  property :author, public: true
+  property :other, optional: true
+
+  def title
+    post.title
+  end
+
+  def body
+    post.body
+  end
+end
+
+Post = Struct.new(:title, :body)
+post = Post.new('hello', 'world')
+
+view_model = PostViewModel.new(post: post, author: 'willnet')
+view.title #=> 'hello'
+view.body #=> 'world'
+view.author #=> 'willnet'
+view.post #=> NoMethodError
+```
+
+### property
+
+`.property` method register property to the class.
+
+Those registered by property need to be passed as arguments to the `initialize` except when `optional: true` is attached. You get ArgumentError if you don't pass `property` to `initialize`.
+
+Property is default to private. This means you can use it in internal the instance. If you want to use it as public, use `public: true` option.
+
+### Auto Assign
+
+You can use ViewModel in a controller like following
+
+```ruby
+class PostsController
+  def show
+    @view_model = PostViewModel.new(post: post, author: 'willnet')
+  end
+end
+```
+
+In view template, if you want to access post and author, you have to use `@view_model` instance variable like `@view_model.post.title`. if it feels troublesome, you can write like following
+
+```ruby
+class PostsController
+  def show
+    view_model = PostViewModel.new(post: post, author: 'willnet')
+    render view_model: view_model
+  end
+end
+```
+
+view_model option of render takes ViewModel, which get it's public methods (include public property) and assign them to instance variables in view template. So you can write `<%= @post.title %>` instead of `<%= @view_model.post.title %>`
+
+## Service
+
+Service is useful when controller has many application logic.
+
+```ruby
+class PostController < ApplicationController
+  def new
+    @post = CreatePostService.call(user: current_user).post
+  end
+
+  def create
+    service = CreatePostService.call(user: current_user, params: params)
+
+    if service.success?
+      redirect_to root_path
+    else
+      @post = service.post
+      render :new
+    end
+  end
+end
+
+class CreatePostService < Yuba::Service
+  property :user, public: true
+  property :params, optional: true
+
+  def call
+    if post.save
+      notify_to_admin
+    else
+      fail!
+    end
+  end
+
+  def post
+    user.posts.build(post_params)
+  end
+
+  private
+
+  def notify_to_admin
+    AdminMailer.notify_create_post(post).deliver_later
+  end
+
+  def post_params
+    params.require(:post).permit(:title, :body)
+  end
+end
+```
+
+- `.property` method register property to the class like ViewModel.
+- `.call` invokes `#call` after assigning arguments as properties.
+- `#success?` returns `true` if you don't invoke `#fail!`
+
+## Form
+
+Form is just wrapper of [reform-rails](https://github.com/trailblazer/reform-rails) for now.
+
+You can see documentation [here](http://trailblazer.to/gems/reform/rails.html).
+
+## Combination Sample
+
+```ruby
+class ArtistsController < ApplicationController
+  def new
+    @view_model = Artist::CreateService.new(params: params).view_model
+  end
+
+  def create
+    service = Artist::CreateService.call(params: params)
+
+    if service.success?
+      redirect_to artists_path
+    else
+      @view_model = service.view_model
+      render :new
+    end
+  end
+```
+
+```ruby
+class Artist::CreateService < Yuba::Service
+  property :params
+
+  def call
+    if form.validate(params)
+      form.save
+    else
+      fail!
+    end
+  end
+
+  def view_model
+    Artist::CreateViewModel.new(form: form)
+  end
+
+  private
+
+  def form
+    @form ||= ArtistForm.new(Artist.new)
+  end
+end
+```
+
+```ruby
+class ArtistForm < Yuba::Form
+  property :name
+
+  validates :name, presence: true, length: { maximum: 100 }
+end
+```
+
+```ruby
+class Artist::CreateViewModel < Yuba::ViewModel
+  property :form, public: true
+end
+```
+
+## generators
+
+You can use generators.
+
+```
+rails generate yuba:service create_artist
+rails generate yuba:form artist
+rails generate yuba:view_model artist_index
 ```
 
 ## Contributing
-Contribution directions go here.
+
+You can try to test by doing as following
+
+```
+git clone https://github.com/willnet/yuba.git
+cd yuba
+bundle
+bundle exec rake
+```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/yuba/form/form_generator.rb

@@ -0,0 +1,9 @@
+module Yuba
+  class FormGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_form
+      template 'form.tt', File.join('app/forms', class_path, "#{file_name}_form.rb")
+    end
+  end
+end

data/lib/generators/yuba/form/templates/form.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Form < Yuba::Form
+end
+<% end -%>

data/lib/generators/yuba/service/service_generator.rb

@@ -0,0 +1,9 @@
+module Yuba
+  class ServiceGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_service
+      template 'service.tt', File.join('app/services', class_path, "#{file_name}_service.rb")
+    end
+  end
+end

data/lib/generators/yuba/service/templates/service.tt

@@ -0,0 +1,6 @@
+<% module_namespacing do -%>
+class <%= class_name %>Service < Yuba::Service
+  def call
+  end
+end
+<% end -%>

data/lib/generators/yuba/view_model/templates/view_model.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>ViewModel < Yuba::ViewModel
+end
+<% end -%>

data/lib/generators/yuba/view_model/view_model_generator.rb

@@ -0,0 +1,9 @@
+module Yuba
+  class ViewModelGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_view_model
+      template 'view_model.tt', File.join('app/view_models', class_path, "#{file_name}_view_model.rb")
+    end
+  end
+end

data/lib/yuba.rb

@@ -1,5 +1,13 @@
+require 'reform/rails'
+require 'dry/types'
+
 module Yuba
   autoload :Form, 'yuba/form'
   autoload :Service, 'yuba/service'
   autoload :ViewModel, 'yuba/view_model'
+  autoload :Rendering, 'yuba/rendering'
+end
+
+ActiveSupport.on_load(:action_controller) do
+  ActionController::Base.include(Yuba::Rendering)
 end

data/lib/yuba/form.rb

@@ -1,60 +1,15 @@
-module Yuba
-  class Form
-    autoload :Attribute, 'yuba/form/attribute'
-    autoload :Attributes, 'yuba/form/attributes'
-    autoload :Collection, 'yuba/form/collection'
-
-    include ActiveModel::Model
-    class_attribute :_model_attribute
-    class_attribute :attributes
+require 'yuba/form/coercion'
+require 'yuba/form/multi_parameter_attributes'
 
+module Yuba
+  class Form < ::Reform::Form
     class << self
-      # TODO: reformのようにネストできるようにしたい
-      def attribute(name, type: 'string', &block)
-        mod = Module.new do
-          define_method(name) do
-            attributes[name.to_s]
-          end
-          define_method("#{name}=") do |value|
-            write_attribute(name.to_s, value, block)
-          end
-        end
-        include mod
-      end
-
-      def collection(name)
+      def inherited(subclass)
+        subclass.feature Coercion
+        subclass.feature MultiParameterAttributes
+        subclass.include Reform::Form::ActiveRecord
+        subclass.include Reform::Form::ActiveModel::ModelReflections
       end
-
-      def model(name)
-        self._model_attribute = name
-      end
-
-      def build(**args)
-        new(**args)
-      end
-    end
-
-    def save
-      valid? && persist
-    end
-
-    def persist
-    end
-
-    def model
-      send(_model_attribute)
-    end
-
-    def model_name
-      model&.model_name
-    end
-
-    private
-
-    def write_attribute(name, value, block)
-      # TODO: convert value by type of attribute
-      value = Attributes.new(value, &block) if block
-      attributes[name] = value
     end
   end
 end

data/lib/yuba/form/coercion.rb

@@ -0,0 +1,36 @@
+require 'dry-types'
+
+module Yuba
+  class Form < ::Reform::Form
+    module Coercion
+      module Types
+        include Dry::Types.module
+      end
+
+      module ClassMethods
+        def property(name, options={}, &block)
+          super(name, options, &block).tap do
+            break unless options[:type]
+            coercing_setter!(name, options[:type])
+          end
+        end
+
+        def coercing_setter!(name, type)
+          class_name = type.to_s.classify
+          type_class = "Yuba::Form::Coercion::Types::Form::#{class_name}".constantize
+
+          mod = Module.new do
+            define_method("#{name}=") do |value|
+              super type_class.(value)
+            end
+          end
+          include mod
+        end
+      end
+
+      def self.included(includer)
+        includer.extend ClassMethods
+      end
+    end
+  end
+end

data/lib/yuba/form/multi_parameter_attributes.rb

@@ -0,0 +1,52 @@
+module Yuba::Form::MultiParameterAttributes
+  # TODO: implement this with parse_filter, so we don't have to manually walk through the hash, etc.
+  class DateTimeParamsFilter
+    def call(params)
+      params = params.dup # DISCUSS: not sure if that slows down form processing?
+      date_attributes = {}
+
+      params.each do |attribute, value|
+        if value.is_a?(Hash)
+          params[attribute] = call(value) # TODO: #validate should only handle local form params.
+        elsif matches = attribute.match(/^(\w+)\(.i\)$/)
+          date_attribute = matches[1]
+          date_attributes[date_attribute] = params_to_date(
+            params.delete("#{date_attribute}(1i)"),
+            params.delete("#{date_attribute}(2i)"),
+            params.delete("#{date_attribute}(3i)"),
+            params.delete("#{date_attribute}(4i)"),
+            params.delete("#{date_attribute}(5i)")
+          )
+        end
+      end
+
+      date_attributes.each do |attribute, date|
+        params[attribute] = date
+      end
+      params
+    end
+
+  private
+    def params_to_date(year, month, day, hour, minute)
+      date_fields = [year, month, day].map!(&:to_i)
+      time_fields = [hour, minute].map!(&:to_i)
+
+      if date_fields.any?(&:zero?) || !Date.valid_date?(*date_fields)
+        return nil
+      end
+
+      if hour.blank? && minute.blank?
+        Date.new(*date_fields)
+      else
+        args = date_fields + time_fields
+        Time.zone ? Time.zone.local(*args) :
+          Time.new(*args)
+      end
+    end
+  end
+
+  # this hooks into the format-specific #deserialize! method.
+  def deserialize!(params)
+    super DateTimeParamsFilter.new.call(params) # if params.is_a?(Hash) # this currently works for hash, only.
+  end
+end

data/lib/yuba/rendering.rb

@@ -0,0 +1,33 @@
+module Yuba
+  module Rendering
+    def render(*args)
+      view_model_hash = args.find { |arg| arg.is_a?(Hash) && arg[:view_model] }
+      @_view_model = view_model_hash[:view_model] if view_model_hash[:view_model]
+      super
+    end
+
+    def view_assigns
+      super.merge(view_model_assigns)
+    end
+
+    private
+
+    def _protected_ivars
+      super.merge(:@_view_model)
+    end
+
+    def view_model_assigns
+      return {} unless @_view_model
+      # TODO: get all public methods between self and Yuba::ViewModel
+      #       now get only in self
+      methods = @_view_model.public_methods(false)
+      methods.reject! do |method_name|
+        %i[call initialize].include?(method_name)
+      end
+      methods.inject({}) do |hash, method_name|
+        hash[method_name] = @_view_model.public_send(method_name)
+        hash
+      end
+    end
+  end
+end

data/lib/yuba/service.rb

@@ -1,37 +1,60 @@
 module Yuba
   class Service
+    class_attribute :_properties
+    self._properties = {}
+
     class << self
       def call(**args)
-        service = new
-        return_value = args.present? ? service.call(**args) : service.call
-        if return_value.respond_to?(:success?)
-          return_value
-        else
-          result.success(form: service.form)
-        end
+        service = args.empty? ? new : new(**args)
+        service.call
+        service
+      end
+
+      def property(name, options = {})
+        _properties[name.to_sym] = options
       end
     end
 
-    def build_form(**args)
-      form_class.build(**args)
+    def initialize(**args)
+      validate_arguments(args)
+      define_accessors(args)
+      success
+    end
+
+    def success
+      @_success = true
     end
 
-    def form_class
-      Object.const_get(form_class_name)
+    def fail!
+      @_success = false
     end
 
-    def view_model_class
-      Object.const_get(form_class_name)
+    def success?
+      @_success
+    end
+
+    def failure?
+      !@_success
     end
 
     private
 
-    def form_class_name
-      self.class.name.sub(/::.+Service/, 'Form')
+    def validate_arguments(args)
+      args.each_key do |key|
+        if !_properties.has_key?(key.to_sym) && !_properties.dig(key.to_sym, :optional)
+          raise ArgumentError, "missing 'property :#{key}' in #{self.class.name} class"
+        end
+      end
     end
 
-    def view_model_class_name
-      self.class.name.sub(/Service\z/, 'ViewModel')
+    def define_accessors(args)
+      args.each do |key, value|
+        public_method = _properties[key.to_sym][:public]
+        define_singleton_method key do
+          value
+        end
+        self.singleton_class.class_eval { private key.to_sym } unless public_method
+      end
     end
   end
 end

data/lib/yuba/version.rb

@@ -1,3 +1,3 @@
 module Yuba
-  VERSION = '0.0.1.pre'
+  VERSION = '0.0.1'
 end

data/lib/yuba/view_model.rb

@@ -1,26 +1,45 @@
 module Yuba
   class ViewModel
+    class_attribute :_properties
+    self._properties = {}
+
     class << self
-      def success(**args)
-        new(args.merge(success: true))
+      # You can register property to the class.
+      # Those registered by property need to be passed as arguments to the `initialize` except when `optional: true`
+      # is attached. You get `ArgumentError` if you don't pass `property` to `initialize`.
+      # Property is default to private. This means you can use it in internal the instance.
+      # If you it as public, use `public: true` option.
+      #
+      #   property :name, public: true
+      #   property :email, optional: true
+      def property(name, options = {})
+        _properties[name.to_sym] = options
       end
     end
 
-    def initialize(success: true, **args)
-      @success = success
-      args.each { |k,v| self.class.send(:define_method, k) { v } }
+    def initialize(**args)
+      validate_arguments(args)
+      define_accessors(args)
     end
 
-    def success?
-      @success
-    end
+    private
 
-    def failure?
-      !@success
+    def validate_arguments(args)
+      args.each_key do |key|
+        if !_properties.has_key?(key.to_sym) && !_properties.dig(key.to_sym, :optional)
+          raise ArgumentError, "missing 'property :#{key}' in #{self.class.name} class"
+        end
+      end
     end
 
-    def to_model
-      form
+    def define_accessors(args)
+      args.each do |key, value|
+        public_method = _properties[key.to_sym][:public]
+        define_singleton_method key do
+          value
+        end
+        self.singleton_class.class_eval { private key.to_sym } unless public_method
+      end
     end
   end
 end

metadata

@@ -1,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: yuba
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.1
 platform: ruby
 authors:
 - willnet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: reform-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chromedriver-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add New Layers to Rails. Form, Service, ViewModel.
 email:
 - netwillnet@gmail.com
@@ -48,11 +146,18 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/yuba/form/form_generator.rb
+- lib/generators/yuba/form/templates/form.tt
+- lib/generators/yuba/service/service_generator.rb
+- lib/generators/yuba/service/templates/service.tt
+- lib/generators/yuba/view_model/templates/view_model.tt
+- lib/generators/yuba/view_model/view_model_generator.rb
 - lib/tasks/crepe_tasks.rake
 - lib/yuba.rb
 - lib/yuba/form.rb
-- lib/yuba/form/attribute.rb
-- lib/yuba/form/attributes.rb
+- lib/yuba/form/coercion.rb
+- lib/yuba/form/multi_parameter_attributes.rb
+- lib/yuba/rendering.rb
 - lib/yuba/service.rb
 - lib/yuba/version.rb
 - lib/yuba/view_model.rb
@@ -71,12 +176,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Add New Layers to Rails

data/lib/yuba/form/attribute.rb

@@ -1,9 +0,0 @@
-module Yuba
-  class Form
-    class Attribute
-      def initialize(name)
-        @name = name
-      end
-    end
-  end
-end

data/lib/yuba/form/attributes.rb

@@ -1,44 +0,0 @@
-module Yuba
-  module Form
-    class Attributes
-      class_attribute :attributes
-      self.attributes = {}
-
-      def initialize(value)
-        yield if block_given?
-        deep_assign(value)
-      end
-
-      def attribute(name, type: string, &block)
-        mod = Module.new do
-          define_method(name) do
-            attributes[name.to_s]
-          end
-          define_method("#{name}=") do |value|
-            write_attribute(name.to_s, value, block)
-          end
-        end
-        include mod
-      end
-
-      private
-
-      def write_attribute(name, value, block)
-        # TODO: convert value by type of attribute
-        value = Attributes.new(value, &block) if block
-        attributes[name] = value
-      end
-
-      def deep_assign(value)
-        raise ArgumentError unless value.is_a? Hash
-        value.each do |k,v|
-          if v.is_a? Hash
-            deep_assign(v)
-          else
-            attributes[name.to_s] = v
-          end
-        end
-      end
-    end
-  end
-end