essay 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c397065af85bfaa45635847b7a96c1ec7e75a7b4
+  data.tar.gz: a4ab9c5a04548f6cccea372596e468bf9fde4cdb
+SHA512:
+  metadata.gz: 58772dc8270cfb20289db16e7fee4969fed6e834ba67dfef46c86056bb71ad11a15ab00d0e0af02714eacca0944436c917f34979917281b9d27873a4f2ad4991
+  data.tar.gz: 8e36d383b357f52fa25835217f2657ec7da439e9639e9826dd9efb9a1730bc72e7fb570cbdc47af8297445b18fe484abf7edcbfd5d5962a5e8acd893327cbf64

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in confo.gemspec
+gemspec
+
+gem 'activerecord-traits', path: '~/Development/activerecord-traits'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yaroslav Konoplov
+
+MIT License
+
+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,29 @@
+# Essay
+
+##### This library provides a series of classes to obtain plugin information of ActiveRecord models.
+This library is focused only on ***custom*** ActiveRecord features and will not provide information for default ActiveRecord features.
+
+### The problem
+There are a lot of plugins for ActiveRecord. For example:
+
+ - Plugins for translation (Globalize)
+ - Plugins for file attachments (CarrierWave, PaperClip)
+ - Plugins for safe deleting (Paranoid)
+ - Plugins for taggings
+ - Plugins for geocoding
+ - Plugins for social networks (likes, shares etc)
+ - and others...
+
+Each of this plugins adds and/or removes and/or modifies behaviours of model. For example: adds callbacks, validations, methods, adds some imaginary meaning for attributes (good example: `deleted_at` when using paranoid). Each plugin uses different way of storing its options.
+
+So, what if we need to know what plugins model is using and plugin options? ActiveRecord does not provide standardized way of developing and storing plugin options. **This library provides a series of classes and utilities for creating essay writers (classes which provide information about specific ActiveRecord plugin) with unified API design.**  
+
+### Example for Globalize
+```ruby
+# TODO
+```
+
+## Gemfile
+```ruby
+gem 'essay', github: 'yivo/essay'
+```

data/essay.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require File.expand_path('../lib/essay/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name            = 'essay'
+  s.version         = Essay::VERSION
+  s.authors         = ['Yaroslav Konoplov']
+  s.email           = ['eahome00@gmail.com']
+  s.summary         = 'Feature information of activerecord models'
+  s.description     = 'Feature information of activerecord models, attributes and associations'
+  s.homepage        = 'http://github.com/yivo/essay'
+  s.license         = 'MIT'
+
+  s.executables     = `git ls-files -z -- bin/*`.split("\x0").map{ |f| File.basename(f) }
+  s.files           = `git ls-files -z`.split("\x0")
+  s.test_files      = `git ls-files -z -- {test,spec,features}/*`.split("\x0")
+  s.require_paths   = ['lib']
+
+  s.add_dependency 'activesupport', '>= 3.0', '< 6.0'
+  s.add_dependency 'activerecord',  '>= 3.0', '< 6.0'
+  s.add_dependency 'traits',        '~> 1.0'
+end

data/lib/essay.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'active_support/all'
+require 'active_record'
+
+require 'essay/model/model_features'
+require 'essay/model/base_feature'
+
+require 'essay/attribute/attribute_collection'
+require 'essay/attribute/attribute_features'
+require 'essay/attribute/base_feature'
+
+require 'essay/association/association_collection'
+require 'essay/association/association_features'
+require 'essay/association/base_feature'
+
+class ActiveRecord::Base
+  class << self
+    def features
+      @features_for_model ||= Essay::ModelFeatures.new(model_class: self)
+    end
+
+    def attribute_features(attr_name = nil)
+      @features_for_attrs ||= Essay::AttributeCollection.new(model_class: self)
+      attr_name ? @features_for_attrs[attr_name] : @features_for_attrs
+    end
+
+    def association_features(assoc_name = nil)
+      @features_for_assocs ||= Essay::AssociationCollection.new(model_class: self)
+      assoc_name ? @features_for_assocs[assoc_name] : @features_for_assocs
+    end
+
+    def essay_for(attr_or_assoc)
+      raise NotImplmentedError
+    end
+  end
+end

data/lib/essay/abstract_collection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+require 'essay/helpers/model_helper'
+
+module Essay
+  class AbstractCollection
+    include ModelHelper
+
+    def initialize(env)
+      @env          = env
+      @model_class  = env.fetch(:model_class)
+      @features_for = {}
+    end
+
+    def [](name)
+      @features_for[convert_key(name)] ||= construct_features(name)
+    end
+
+    def load_contents
+
+    end
+
+    def to_hash
+      @features_for.each_with_object({}) do |(k, v), memo|
+        memo[k] = v.to_hash
+      end
+    end
+
+  protected
+    def construct_features(name)
+
+    end
+
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key : key.to_sym
+    end
+  end
+end

data/lib/essay/abstract_feature.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'essay/helpers/model_helper'
+require 'essay/helpers/serialize_helper'
+require 'essay/helpers/description_helper'
+
+module Essay
+  class AbstractFeature
+    include ModelHelper
+    include SerializeHelper
+    include DescriptionHelper
+
+    def initialize(env)
+      @env         = env
+      @model_class = env.fetch(:model_class)
+    end
+  end
+end

data/lib/essay/abstract_features.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'essay/helpers/model_helper'
+require 'essay/helpers/feature_helper'
+require 'essay/helpers/serialize_helper'
+
+module Essay
+  class AbstractFeatures
+    include ModelHelper
+    include FeatureHelper
+    include SerializeHelper
+
+    attr_reader :env
+
+    def initialize(env)
+      @env         = env
+      @model_class = env.fetch(:model_class)
+    end
+  end
+end

data/lib/essay/association/association_collection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'essay/abstract_collection'
+
+module Essay
+  class AssociationCollection < AbstractCollection
+    def construct_features(assoc_name)
+      Essay::AssociationFeatures.new(@env.merge(association_name: assoc_name))
+    end
+
+    protected :construct_features
+  end
+end

data/lib/essay/association/association_features.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'essay/abstract_features'
+require 'essay/helpers/association_helper'
+
+module Essay
+  class AssociationFeatures < AbstractFeatures
+    include AssociationHelper
+
+    def initialize(env)
+      super
+      @association_name = env.fetch(:association_name)
+    end
+  end
+end

data/lib/essay/association/base_feature.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'essay/abstract_feature'
+require 'essay/helpers/association_helper'
+
+module Essay
+  class AssociationFeatures::Base < AbstractFeature
+    include AssociationHelper
+
+    def initialize(env)
+      super
+      @association_name = env.fetch(:association_name)
+    end
+  end
+end

data/lib/essay/attribute/attribute_collection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'essay/abstract_collection'
+
+module Essay
+  class AttributeCollection < AbstractCollection
+    def construct_features(attr_name)
+      Essay::AttributeFeatures.new(@env.merge(attribute_name: attr_name))
+    end
+
+    protected :construct_features
+  end
+end

data/lib/essay/attribute/attribute_features.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'essay/abstract_features'
+require 'essay/helpers/attribute_helper'
+
+module Essay
+  class AttributeFeatures < AbstractFeatures
+    include AttributeHelper
+
+    def initialize(env)
+      super
+      @attribute_name = env.fetch(:attribute_name)
+    end
+  end
+end

data/lib/essay/attribute/base_feature.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'essay/abstract_feature'
+require 'essay/helpers/attribute_helper'
+
+module Essay
+  class AttributeFeatures::Base < AbstractFeature
+    include AttributeHelper
+
+    def initialize(env)
+      super
+      @attribute_name = env.fetch(:attribute_name)
+    end
+  end
+end

data/lib/essay/helpers/association_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Essay
+  module AssociationHelper
+    def association_name
+      @association_name
+    end
+
+    def association_traits
+      model_traits.associations[association_name]
+    end
+
+    alias association association_traits
+    alias this_association association
+  end
+end

data/lib/essay/helpers/attribute_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Essay
+  module AttributeHelper
+    def attribute_name
+      @attribute_name
+    end
+
+    def attribute_traits
+      model_traits.attributes[attribute_name]
+    end
+
+    alias attribute attribute_traits
+    alias this_attribute attribute
+  end
+end

data/lib/essay/helpers/description_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module Essay
+  module DescriptionHelper
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :description, instance_predicate: false, instance_writer: false
+    end
+
+    module ClassMethods
+      def describe(description)
+        self.description = description
+      end
+    end
+  end
+end

data/lib/essay/helpers/feature_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Essay
+  module FeatureHelper
+    def is(thing)
+      send(thing)
+    end
+
+    def not(thing)
+      send(thing)
+    end
+
+    def with(thing, &block)
+      obj = send(thing)
+      block.call(obj) if obj
+    end
+  end
+end

data/lib/essay/helpers/model_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Essay
+  module ModelHelper
+    def model_class
+      @model_class
+    end
+
+    def model_traits
+      model_class.traits
+    end
+
+    def model_associations
+      model_traits.associations
+    end
+
+    alias all_associations model_associations
+
+    def model_attributes
+      model_traits.attributes
+    end
+
+    alias all_attributes model_attributes
+
+    def model_features
+      model_class.features
+    end
+  end
+end

data/lib/essay/helpers/serialize_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Essay
+  module SerializeHelper
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def serialize(options = {}, &block)
+        serialize_steps << { block: block, options: options }
+      end
+
+      def serialize_steps
+        @serialize_steps ||= []
+      end
+    end
+
+    def to_hash
+      serialize_steps.each_with_object({}) do |step, result|
+        condition = step.fetch(:options)[:if]
+        if !condition || try(condition)
+          result.merge!(instance_exec(&step.fetch(:block)))
+        end
+      end
+    end
+
+    def serialize_steps
+      self.class.serialize_steps
+    end
+  end
+end

data/lib/essay/model/base_feature.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'essay/abstract_feature'
+
+module Essay
+  class ModelFeatures::Base < AbstractFeature
+  end
+end

data/lib/essay/model/model_features.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'essay/abstract_features'
+
+module Essay
+  class ModelFeatures < AbstractFeatures
+  end
+end

data/lib/essay/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Essay
+  VERSION = '1.0.1'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: essay
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Yaroslav Konoplov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: traits
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Feature information of activerecord models, attributes and associations
+email:
+- eahome00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- essay.gemspec
+- lib/essay.rb
+- lib/essay/abstract_collection.rb
+- lib/essay/abstract_feature.rb
+- lib/essay/abstract_features.rb
+- lib/essay/association/association_collection.rb
+- lib/essay/association/association_features.rb
+- lib/essay/association/base_feature.rb
+- lib/essay/attribute/attribute_collection.rb
+- lib/essay/attribute/attribute_features.rb
+- lib/essay/attribute/base_feature.rb
+- lib/essay/helpers/association_helper.rb
+- lib/essay/helpers/attribute_helper.rb
+- lib/essay/helpers/description_helper.rb
+- lib/essay/helpers/feature_helper.rb
+- lib/essay/helpers/model_helper.rb
+- lib/essay/helpers/serialize_helper.rb
+- lib/essay/model/base_feature.rb
+- lib/essay/model/model_features.rb
+- lib/essay/version.rb
+homepage: http://github.com/yivo/essay
+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.1
+signing_key: 
+specification_version: 4
+summary: Feature information of activerecord models
+test_files: []