objectified 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 004ba17c7d6671cca9f8dadad6359197c3d765b47aa64660cd228d18280b201f
+  data.tar.gz: 3c7251ef410290046630a2e93f26acd07beb122efac6755ba88d0fa6b575bf42
+SHA512:
+  metadata.gz: c4d574e699b63accb1386e1139186524e4fd3a5ca84aa1b66c73902dd955909acbbd74f54472f1edad0d493b00911f667b340af35643c81a1d5c3d7ed369c38b
+  data.tar.gz: 0333f648e1163ec41013215066ad65bc2f991b335023deb389b13f716dd6de98f5787a3eb54e6680509d5a80bd3d4e3a27d0bb3b38a6e5e91888ca8d8f5c8e77

data/README.md

@@ -0,0 +1,39 @@
+# Objectified
+
+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/objectified`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'objectified'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install objectified
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/objectified.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/objectified.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require "objectified/version"
+
+require "active_support"
+require "active_support/rails"
+require "active_support/core_ext/string/inflections"
+require "active_support/lazy_load_hooks"
+
+# include this module to have resource based, meta programming variables.
+module Objectified
+  extend ActiveSupport::Autoload
+
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+
+      def self.inherited(subclass)
+        super
+        subclass.object_type(object_type_string)
+      end
+    end
+  end
+
+  # e.g. define object_type :finder for ApplicationFinder
+  module ClassMethods
+    attr_accessor :object_type_string
+
+    #
+    # The entry point of the api is the :object_type method.
+    #
+    #
+    # Note:
+    #    Do not use for classes with the prefix 'Application'.
+    #
+    # Args:
+    #    object_type_string: (String)
+    #
+    # Example:
+    #    class SomeController
+    #      object_type :controller
+    #    end
+    #
+    #    SomeController.resource_klass_string
+    #      => 'Some'
+    #
+
+    def object_type(object_type_string)
+      @object_type_string = object_type_string
+    end
+
+
+    #
+    # Returns the 'object_type' but capitalized and stringified
+    #
+    # Example:
+    #    SomeController.object_type_klass_string
+    #      => 'Controller'
+    #
+
+    def object_type_klass_string
+      @object_type_string&.to_s&.camelcase
+    end
+
+
+    #
+    # Returns the pluralized resource name
+    #
+    # Example:
+    #    SomeController.resources_klass_string
+    #      => 'Somes'
+    #
+
+    def resources_klass_string
+      unless object_type_klass_string
+        raise 'No Object Type Defined. please override object_type in your class => e.g. object_type :controller'
+      end
+
+      to_s.gsub(object_type_klass_string, '').pluralize
+    end
+
+
+    #
+    # Returns the singularized resource name
+    #
+    # Example:
+    #    SomeController.resource_klass_string
+    #      => 'Some'
+    #
+
+    def resources_klass_string
+      resources_klass_string.singularize
+    end
+
+
+    #
+    # Returns the constantized class name of the resource
+    #
+    # Example:
+    #    SomeController.records_klass
+    #      => 'Some'
+    #
+
+    def records_klass
+      return if resource_klass_string == 'Application'
+
+      resource_klass_string&.constantize
+    rescue NameError
+      resource_klass_string
+    end
+
+
+    #
+    # Returns the name of a the **collection variable** for the resource class, with the option of stripping it's namespaces.
+    #
+    # Example:
+    #    SomeNamespace::SomeController.records_instance_variable_name
+    #      => 'some_namespace_somes'
+    #
+    # Example:
+    #    SomeNamespace::SomeController.records_instance_variable_name(namespace: true)
+    #      => 'somes'
+    #
+
+    def records_instance_variable_name(namespace: false)
+      return if resource_klass_string == 'Application'
+
+      if namespace
+        records_klass.to_s.underscore.downcase.pluralize.gsub('/', '_')
+      else
+        records_klass.to_s.underscore.downcase.pluralize.split('/').last
+      end
+    end
+
+
+    #
+    # Returns the name of a the **member variable** for the resource class, with the option of stripping it's namespaces.
+    #
+    # Example:
+    #    SomeNamespace::SomeController.record_instance_variable_name
+    #      => 'some_namespace_some'
+    #
+    # Example:
+    #    SomeNamespace::SomeController.record_instance_variable_name(namespace: true)
+    #      => 'some'
+    #
+
+    def record_instance_variable_name(namespace: false)
+      return if resource_klass_string == 'Application'
+
+      if namespace
+        records_klass.to_s.underscore.downcase
+      else
+        records_klass.to_s.underscore.downcase.split('/').last
+      end
+    end
+
+
+    #
+    # Mixin to extract class names on demand.
+    #
+    # Example:
+    #    SomeNamespace::SomeController.record_instance_variable_name
+    #      => 'some_namespace_some'
+    #
+    # Example:
+    #    SomeNamespace::SomeController.record_instance_variable_name(namespace: true)
+    #      => 'some'
+    #
+    def object_klass_for(object_type)
+      str = "#{resource_klass_string.pluralize}#{object_type.to_s.camelize}"
+      str.constantize
+    end
+  end
+
+  #
+  # Instance Extensions of Class Methods
+  #
+
+  def records_instance_variable_name(namespace: false)
+    self.class.records_instance_variable_name(namespace: namespace)
+  end
+
+  def record_instance_variable_name(namespace: false)
+    self.class.record_instance_variable_name(namespace: namespace)
+  end
+
+  def records_klass
+    self.class.records_klass
+  end
+
+  def resource_klass_string
+    self.class.resource_klass_string
+  end
+
+  def object_klass_for(object_type)
+    self.class.object_klass_for(object_type)
+  end
+
+  def resources_klass_string
+    self.class.resources_klass_string
+  end
+end
+

data/lib/objectified/version.rb

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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: objectified
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Guilherme Andrade
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+description: Extract resource based object names with ease.
+email:
+- guilherme.andrade.ao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog.md
+- README.md
+- lib/objectified.rb
+- lib/objectified/version.rb
+homepage: https://github.com/guilherme-andrade/objectified
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guilherme-andrade/objectified
+  source_code_uri: https://github.com/guilherme-andrade/objectified
+  changelog_uri: https://github.com/guilherme-andrade/objectified/Changelog.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple mixin with meta coding utilities
+test_files: []