xpose 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ee96be30074b9fb645e7d48159959b7f86cb147
+  data.tar.gz: 81c15b2d3b34903825c6fedd574e9f67068e6e9d
+SHA512:
+  metadata.gz: 492f136cf513be70acb664abbd69c53d31713a5f1b8626ecfaf31d95f380570145f5647247b0e29ed17224386600557d8239c030ac8f72832bb463f7ceca07e1
+  data.tar.gz: d6971ad58e3bb88e99841d3b2a24f9e49a3577fb4da5cdaea6359bd717b19fc6a2d7bb1bfd3c281ffb67171fb2b74c284a6d798902fdc1dc45905f616f6652e1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at younes.serraj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    xpose (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  xpose!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Younes Serraj
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Younes SERRAJ
+
+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,35 @@
+# Xpose
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xpose'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+TODO
+
+## Development
+
+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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yoones/xpose. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Xpose project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yoones/xpose/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xpose"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xpose.rb

@@ -0,0 +1,16 @@
+require "xpose/version"
+require "active_support/all"
+
+module Xpose
+  class MissingParameterError < StandardError ; end
+  class UnknownDecoratorError < StandardError ; end
+
+  autoload :Configuration, 'xpose/configuration.rb'
+  autoload :Exposed, 'xpose/exposed.rb'
+  autoload :Decorated, 'xpose/decorated.rb'
+  autoload :Controller, 'xpose/controller.rb'
+
+  ActiveSupport.on_load :action_controller do
+    include Controller
+  end
+end

data/lib/xpose/configuration.rb

@@ -0,0 +1,30 @@
+module Xpose
+  module Configuration
+    DEFAULT_VALUES = {
+      name: nil,
+      value: nil,
+      decorate: true,
+      decorator: :infer,
+      infer_value: true,
+      scope: :all
+    }.freeze
+
+    def self.build(**args)
+      args = DEFAULT_VALUES.merge(args).keep_if do |k, v|
+        DEFAULT_VALUES.has_key?(k)
+      end
+      OpenStruct.new(args).tap do |conf|
+        conf.name = conf.name.to_s
+        conf.method_name = conf.name.to_sym
+        conf.instance_variable_name = :"@#{conf.method_name}"
+
+        conf.singularized_name = conf.name.singularize
+        conf.pluralized_name = conf.name.pluralize
+
+        conf.decorated_name = "decorated_#{conf.name}"
+        conf.decorated_method_name = conf.decorated_name.to_sym
+        conf.decorated_instance_variable_name = :"@decorated_#{conf.method_name}"
+      end
+    end
+  end
+end

data/lib/xpose/controller.rb

@@ -0,0 +1,41 @@
+module Xpose
+  module Controller
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def _expose(**args)
+        ::Xpose::Exposed.new(args).tap do |inst|
+          define_method inst.conf.method_name do
+            if instance_variable_defined?(inst.conf.instance_variable_name)
+              instance_variable_get(inst.conf.instance_variable_name)
+            else
+              instance_variable_set(inst.conf.instance_variable_name, inst.call(self))
+            end
+          end
+          helper_method(inst.conf.method_name)
+          self._decorate(args) if inst.conf[:decorate]
+        end
+      end
+
+      def expose(name, value = nil, **args, &block)
+        value = value || args.fetch(:value, nil) || block
+        _expose({ name: name, value: value }.merge(args))
+      end
+
+      def expose!(name, value = nil, **args, &block)
+        expose(name, value, args, &block)
+        before_action(name)
+      end
+
+      def _decorate(**args)
+        ::Xpose::Decorated.new(args).tap do |inst|
+          _expose({ name: inst.conf.decorated_name, value: -> { inst.call(self) }, decorate: false })
+        end
+      end
+
+      def decorate(name, **args, &block)
+        _decorate({ name: name }.merge(args))
+      end
+    end
+  end
+end

data/lib/xpose/decorated.rb

@@ -0,0 +1,47 @@
+module Xpose
+  class Decorated
+    attr_accessor :conf
+
+    def initialize(**args)
+      @conf = ::Xpose::Configuration.build(args)
+      raise MissingParameter if conf.name.nil?
+    end
+
+    def call(instance)
+      v = instance.send(conf.method_name)
+      if conf.decorator == :infer
+        infer(v)
+      elsif Class === conf.decorator
+        decorator.new(v)
+      elsif decorator.respond_to?(:call)
+        decorator.call(v)
+      elsif Symbol === decorator
+        decorator.to_s.singularize.capitalize.constantize.new(v)
+      else
+        raise StandardError.new('Unknown decorator')
+      end
+    end
+
+    private
+
+    def infer(v)
+      if v.respond_to?(:decorate)
+        v.decorate
+      elsif class_exists?(klass)
+        klass.new(v)
+      else
+        raise UnknownDecoratorError
+      end
+    end
+
+    def klass
+      @klass ||= "#{conf.singularized_name.capitalize}Decorator".constantize
+    end
+
+    def class_exists?(class_name)
+      Module.const_get(class_name).is_a?(Class)
+    rescue NameError
+      return false
+    end
+  end
+end

data/lib/xpose/exposed.rb

@@ -0,0 +1,74 @@
+module Xpose
+  class Exposed
+    attr_accessor :conf
+
+    def initialize(**args)
+      @conf = ::Xpose::Configuration.build(args)
+      conf.name.tap do |name|
+        raise MissingParameterError if name.nil?
+      end
+    end
+
+    def call(instance)
+      @instance = instance
+      v = if conf.value.nil? && conf.infer_value
+            (conf.method_name.to_s == conf.pluralized_name ? :collection : :record)
+          else
+            conf.value
+          end
+      reinterpret_value(v)
+    end
+
+    private
+
+    attr_reader :instance
+
+    def class_exists?(class_name)
+      Module.const_get(class_name).is_a?(Class)
+    rescue NameError
+      return false
+    end
+
+    def klass
+      @klass ||= conf.singularized_name.capitalize.constantize
+    end
+
+    def reinterpret_value(v)
+      if v.respond_to?(:call)
+        instance.instance_exec &v
+      elsif v == :collection
+        infer_collection
+      elsif v == :record
+        infer_record
+      else
+        v
+      end
+    end
+
+    def infer_collection
+      klass.send(scope)
+    end
+
+    def infer_record
+      source = if instance.respond_to?(conf.pluralized_name)
+                 ->{ instance.send(conf.pluralized_name) }
+               else
+                 ->{ klass.send(scope) }
+               end
+      if instance.respond_to?(:params) && instance.params.has_key?(:id)
+        source.call.find(instance.params[:id])
+      else
+        source.call.new(params)
+      end
+    end
+
+    def params
+      @params ||=
+        if instance.respond_to?("#{conf.singularized_name}_params")
+          instance.send("#{conf.singularized_name}_params")
+        else
+          {}
+        end
+    end
+  end
+end

data/lib/xpose/version.rb

@@ -0,0 +1,3 @@
+module Xpose
+  VERSION = "0.1.0"
+end

data/xpose.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "xpose/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "xpose"
+  spec.version       = Xpose::VERSION
+  spec.authors       = ["Younes SERRAJ"]
+  spec.email         = ["younes.serraj@gmail.com"]
+
+  spec.summary       = %q{Helpers to shorten your rails controllers}
+  spec.description   = %q{Set of helpers that help shorten your rails controllers by exposing/decorating attributes with inference capabilities}
+  spec.homepage      = "https://github.com/yoones/xpose"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: xpose
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Younes SERRAJ
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Set of helpers that help shorten your rails controllers by exposing/decorating
+  attributes with inference capabilities
+email:
+- younes.serraj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xpose.rb
+- lib/xpose/configuration.rb
+- lib/xpose/controller.rb
+- lib/xpose/decorated.rb
+- lib/xpose/exposed.rb
+- lib/xpose/version.rb
+- xpose.gemspec
+homepage: https://github.com/yoones/xpose
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Helpers to shorten your rails controllers
+test_files: []