activerecord-hideable 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f8a0667c74c05d54b411feddac8e658d5079b80
+  data.tar.gz: 81a9072e73726b74413cbd5a7f449f4a3e992cbf
+SHA512:
+  metadata.gz: 6da0baa99af42e40cf4f7fe03641a381bf2ae1be553c3a4147e6d79b82e5622f1520356c4245f25b6fb17a14d377846637d8ff332c361edd582e0a48c3e8ee0f
+  data.tar.gz: a26a1165b29ddd4ded55495ed75b9e717de7705b1e35c9c460ed1af1eda77a288e66c202fd9c359549f6c55f01b8651291d1f6340d580425e3e67753397e1bc6

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/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,14 @@
+```ruby
+  class Article < ActiveRecord::Base
+    acts_as_hideable
+  end
+
+  Article.shown                                        # => Returns collection of articles with hidden => false
+  Article.features.hideable?                           # => true
+  Article.attribute_features[:hidden].hideable_toggle? # => true
+```
+
+## Gemfile
+```ruby
+gem 'activerecord-hideable', '~> 1.0'
+```

data/activerecord-hideable.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name            = 'activerecord-hideable'
+  s.version         = '1.0.1'
+  s.authors         = ['Yaroslav Konoplov']
+  s.email           = ['eahome00@gmail.com']
+  s.summary         = 'Toggles for ActiveRecord models'
+  s.description     = 'Toggles for ActiveRecord models'
+  s.homepage        = 'http://github.com/yivo/activerecord-hideable'
+  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 'activerecord-traits', '~> 1.0'
+end

data/lib/activerecord-hideable/essay.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Essay
+  class ModelFeatures
+    def hideable?
+      model_class.respond_to?(:hideable_options)
+    end
+
+    serialize do
+      { is_hideable: hideable? }
+    end
+  end
+
+  class AttributeFeatures
+    def toggle?
+      model_features.hideable? && model_class.hideable_options.fetch(:toggle) == attribute_name
+    end
+
+    serialize do
+      { is_toggle: toggle? }
+    end
+  end
+end

data/lib/activerecord-hideable/macro.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Hideable
+  module Macro
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      #
+      # class Article < ActiveRecord::Base
+      #   acts_as_hideable toggle: :hidden
+      # end
+      #
+      def acts_as_hideable(options = {})
+        options.reverse_merge!(toggle: Hideable.default_column)
+        toggle = options[:toggle]
+
+        scope :hidden, -> { where(toggle => true)  }
+        scope :shown,  -> { where(toggle => false) }
+
+        define_method(:shown?)  {  !self[toggle] }
+        define_method(:hidden?) { !!self[toggle] } unless toggle == :hidden
+
+        unless respond_to?(:hideable_options)
+          class_attribute :hideable_options, instance_accessor: false, instance_predicate: false
+        end
+
+        self.hideable_options = options
+      end
+    end
+  end
+end

data/lib/activerecord-hideable/migration.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Hideable
+  module Migration
+    def toggle(column_name = Hideable.default_column, **options)
+      options.reverse_merge!(null: false, default: false, index: true)
+      column(column_name, :boolean, options)
+    end
+  end
+end

data/lib/activerecord-hideable.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_record'
+require 'activerecord-traits'
+
+require 'activerecord-hideable/macro'
+require 'activerecord-hideable/column_types'
+
+begin
+  require 'essay'
+  require 'activerecord-hideable/essay'
+rescue LoadError
+end
+
+module Hideable
+  class << self
+    attr_accessor :default_column
+  end
+
+  self.default_column = :hidden
+end
+
+class ActiveRecord::Base
+  include Hideable::Macro
+end
+
+class ActiveRecord::ConnectionAdapters::TableDefinition
+  include Hideable::Migration
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-hideable
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Yaroslav Konoplov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-21 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: activerecord-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: Toggles for ActiveRecord models
+email:
+- eahome00@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- activerecord-hideable.gemspec
+- lib/activerecord-hideable.rb
+- lib/activerecord-hideable/essay.rb
+- lib/activerecord-hideable/macro.rb
+- lib/activerecord-hideable/migration.rb
+homepage: http://github.com/yivo/activerecord-hideable
+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: Toggles for ActiveRecord models
+test_files: []