lp-serializable 0.2.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee8c8007befe5042222082f7d355d28d8b5364d0a06499416055c7ff9c2ba24c
-  data.tar.gz: 9eeba9747a87355b25f45c013131374be16ff9c2f4a600c55efbf806f93148e1
+  metadata.gz: a7075a5d45e3269b8dca2d8504bbc73b4e8dfd9de407c2676762f14013903ccf
+  data.tar.gz: 9874bc7adfee9b4173217b22243e34f64c02b268f083a1a6da6f9e2dfb428c16
 SHA512:
-  metadata.gz: 8ec72124b13225234bfcdedb2663f52a5fa474ede7c4a526303d937098e60a1bd7c33342e2e0cfba9f805eb99d82171a9e6e08fb2820b428940ddb5c792febc8
-  data.tar.gz: 9d3899a92c259237da9bdca814bcc7ce00938764cd08ec889028466ec83100fba4e5ddd0a7fd9160aed2f4f788bc862ee1123270c9cdce0af7eab9e892485705
+  metadata.gz: 86ec74de30ed67b821d39814479b3c3af16a25d6c425c0a8bc938bccebf2c9c9b3c3b7507b91eea1c4aeb6580e0f14a1e2258a5c40a84546e57ee648af6c342a
+  data.tar.gz: 2617995b0005c59bd5302aac10fcfc13df80f8e41ee43a811c0d643bfef489bc6a8aac4c659685c2c8c3805baa7f77d4c77945b0941f9068677f9fa9e9e0ec57

data/.rubocop.yml

@@ -0,0 +1,650 @@
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+Naming/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+
+Style/Alias:
+  Description: 'Use alias_method instead of alias.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#alias-method'
+  Enabled: false
+
+Style/ArrayJoin:
+  Description: 'Use Array#join instead of Array#*.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#array-join'
+  Enabled: false
+
+Style/AsciiComments:
+  Description: 'Use only ascii symbols in comments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-comments'
+  Enabled: false
+
+Naming/AsciiIdentifiers:
+  Description: 'Use only ascii symbols in identifiers.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#english-identifiers'
+  Enabled: false
+
+Style/Attr:
+  Description: 'Checks for uses of Module#attr.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr'
+  Enabled: false
+
+Metrics/BlockNesting:
+  Description: 'Avoid excessive block nesting'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count'
+  Enabled: false
+
+Style/CaseEquality:
+  Description: 'Avoid explicit use of the case equality operator(===).'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-case-equality'
+  Enabled: false
+
+Style/CharacterLiteral:
+  Description: 'Checks for uses of character literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-character-literals'
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: true
+  EnforcedStyle: nested
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  Enabled: false
+
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 100 lines of code.'
+  Enabled: false
+
+Style/ClassVars:
+  Description: 'Avoid the use of class variables.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-class-vars'
+  Enabled: false
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    find: detect
+    inject: reduce
+    collect: map
+    find_all: select
+
+Style/ColonMethodCall:
+  Description: 'Do not use :: for method call.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#double-colons'
+  Enabled: false
+
+Style/CommentAnnotation:
+  Description: >-
+                 Checks formatting of special comments
+                 (TODO, FIXME, OPTIMIZE, HACK, REVIEW).
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#annotate-keywords'
+  Enabled: false
+
+Metrics/AbcSize:
+  Description: >-
+                 A calculated magnitude based on number of assignments,
+                 branches, and conditions.
+  Enabled: false
+
+Metrics/BlockLength:
+  CountComments: true  # count full line comments?
+  Max: 25
+  ExcludedMethods: []
+  Exclude:
+    - "spec/**/*"
+
+Metrics/CyclomaticComplexity:
+  Description: >-
+                 A complexity metric that is strongly correlated to the number
+                 of test cases needed to validate a method.
+  Enabled: false
+
+Rails/Delegate:
+  Description: 'Prefer delegate method for delegations.'
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Description: 'Checks use of `has_key?` and `has_value?` Hash methods.'
+  StyleGuide: '#hash-key'
+  Enabled: false
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/DoubleNegation:
+  Description: 'Checks for uses of double negation (!!).'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-bang-bang'
+  Enabled: false
+
+Style/EachWithObject:
+  Description: 'Prefer `each_with_object` over `inject` or `reduce`.'
+  Enabled: false
+
+Style/EmptyLiteral:
+  Description: 'Prefer literals to Array.new/Hash.new/String.new.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#literal-array-hash'
+  Enabled: false
+
+# Checks whether the source file has a utf-8 encoding comment or not
+# AutoCorrectEncodingComment must match the regex
+# /#.*coding\s?[:=]\s?(?:UTF|utf)-8/
+Style/Encoding:
+  Enabled: false
+
+Style/EvenOdd:
+  Description: 'Favor the use of Fixnum#even? && Fixnum#odd?'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
+  Enabled: false
+
+Naming/FileName:
+  Description: 'Use snake_case for source file names.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#snake-case-files'
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Description: >-
+    Add the frozen_string_literal comment to the top of files
+    to help transition from Ruby 2.3.0 to Ruby 3.0.
+  Enabled: false
+
+Style/FlipFlop:
+  Description: 'Checks for flip flops'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-flip-flops'
+  Enabled: false
+
+Style/FormatString:
+  Description: 'Enforce the use of Kernel#sprintf, Kernel#format or String#%.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#sprintf'
+  Enabled: false
+
+Style/GlobalVars:
+  Description: 'Do not introduce global variables.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#instance-vars'
+  Reference: 'http://www.zenspider.com/Languages/Ruby/QuickRef.html'
+  Enabled: false
+
+Style/GuardClause:
+  Description: 'Check for conditionals that can be replaced with guard clauses'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Description: >-
+                 Favor modifier if/unless usage when you have a
+                 single-line body.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
+  Enabled: false
+
+Style/IfWithSemicolon:
+  Description: 'Do not use if x; .... Use the ternary operator instead.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs'
+  Enabled: false
+
+Style/InlineComment:
+  Description: 'Avoid inline comments.'
+  Enabled: false
+
+Style/Lambda:
+  Description: 'Use the new lambda literal syntax for single-line blocks.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#lambda-multi-line'
+  Enabled: false
+
+Style/LambdaCall:
+  Description: 'Use lambda.call(...) instead of lambda.(...).'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc-call'
+  Enabled: false
+
+Style/LineEndConcatenation:
+  Description: >-
+                 Use \ instead of + or << to concatenate two string literals at
+                 line end.
+  Enabled: false
+
+Metrics/LineLength:
+  Description: 'Limit lines to 80 characters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
+  Max: 80
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
+  Enabled: false
+
+Style/ModuleFunction:
+  Description: 'Checks for usage of `extend self` in modules.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#module-function'
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Description: 'Avoid multi-line chains of blocks.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
+  Enabled: false
+
+Style/NegatedIf:
+  Description: >-
+                 Favor unless over if for negative conditions
+                 (or control flow or).
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#unless-for-negatives'
+  Enabled: false
+
+Style/NegatedWhile:
+  Description: 'Favor until over while for negative conditions.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#until-for-negatives'
+  Enabled: false
+
+Style/Next:
+  Description: 'Use `next` to skip iteration instead of a condition at the end.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals'
+  Enabled: false
+
+Style/NilComparison:
+  Description: 'Prefer x.nil? to x == nil.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#predicate-methods'
+  Enabled: false
+
+Style/Not:
+  Description: 'Use ! instead of not.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bang-not-not'
+  Enabled: false
+
+Style/NumericLiterals:
+  Description: >-
+                 Add underscores to large numeric literals to improve their
+                 readability.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
+  Enabled: false
+
+Style/OneLineConditional:
+  Description: >-
+                 Favor the ternary operator(?:) over
+                 if/then/else/end constructs.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#ternary-operator'
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Description: 'When defining binary operators, name the argument other.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#other-arg'
+  Enabled: false
+
+Metrics/ParameterLists:
+  Description: 'Avoid parameter lists longer than three or four parameters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#too-many-params'
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Description: 'Use `%`-literal delimiters consistently'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-literal-braces'
+  Enabled: false
+
+Style/PerlBackrefs:
+  Description: 'Avoid Perl-style regex back references.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers'
+  Enabled: false
+
+Naming/PredicateName:
+  Description: 'Check the names of predicate methods.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark'
+  NamePrefixBlacklist:
+    - is_
+  Exclude:
+    - spec/**/*
+
+Style/Proc:
+  Description: 'Use proc instead of Proc.new.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#proc'
+  Enabled: false
+
+Style/RaiseArgs:
+  Description: 'Checks the arguments passed to raise/fail.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#exception-class-messages'
+  Enabled: false
+
+Style/RegexpLiteral:
+  Description: 'Use / or %r around regular expressions.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-r'
+  Enabled: false
+
+Style/SelfAssignment:
+  Description: >-
+                 Checks for places where self-assignment shorthand should have
+                 been used.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#self-assignment'
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#reduce-blocks'
+  Enabled: false
+
+Style/SingleLineMethods:
+  Description: 'Avoid single-line methods.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-single-line-methods'
+  Enabled: false
+
+Style/SignalException:
+  Description: 'Checks for proper usage of fail and raise.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#fail-method'
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Description: 'Avoid Perl-style global variables.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms'
+  Enabled: false
+
+Style/StringLiterals:
+  Description: 'Checks if uses of quotes match the configured preference.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrivialAccessors:
+  Description: 'Prefer attr_* methods to trivial readers/writers.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#attr_family'
+  Enabled: false
+
+Style/VariableInterpolation:
+  Description: >-
+                 Don't interpolate global, instance and class variables
+                 directly in strings.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#curlies-interpolate'
+  Enabled: false
+
+Style/WhenThen:
+  Description: 'Use when x then ... for one-line cases.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#one-line-cases'
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Description: >-
+                 Favor modifier while/until usage when you have a
+                 single-line body.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier'
+  Enabled: false
+
+Style/WordArray:
+  Description: 'Use %w or %W for arrays of words.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#percent-w'
+  Enabled: false
+
+# Layout
+
+Layout/AlignParameters:
+  Description: 'Here we check if the parameters on a multi-line method call or definition are aligned.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
+  Enabled: false
+
+Layout/ConditionPosition:
+  Description: >-
+                 Checks for condition placed in a confusing position relative to
+                 the keyword.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
+  Enabled: false
+
+Layout/DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
+  EnforcedStyle: trailing
+
+Layout/ExtraSpacing:
+  Description: 'Do not use unnecessary spacing.'
+  Enabled: true
+
+Layout/MultilineOperationIndentation:
+  Description: >-
+                 Checks indentation of binary operations that span more than
+                 one line.
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  Description: >-
+                 Checks indentation of method calls with the dot operator
+                 that span more than one line.
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/InitialIndentation:
+  Description: >-
+    Checks the indentation of the first non-blank non-comment line in a file.
+  Enabled: false
+
+# Lint
+
+Lint/AmbiguousOperator:
+  Description: >-
+                 Checks for ambiguous operators in the first argument of a
+                 method invocation without parentheses.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-as-args'
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Description: >-
+                 Checks for ambiguous regexp literals in the first argument of
+                 a method invocation without parenthesis.
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Description: "Don't use assignment in conditions."
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition'
+  Enabled: false
+
+Lint/CircularArgumentReference:
+  Description: "Don't refer to the keyword argument in the default value."
+  Enabled: false
+
+Lint/DeprecatedClassMethods:
+  Description: 'Check for deprecated class method calls.'
+  Enabled: false
+
+Lint/DuplicatedKey:
+  Description: 'Check for duplicate keys in hash literals.'
+  Enabled: false
+
+Lint/EachWithObjectArgument:
+  Description: 'Check for immutable argument given to each_with_object.'
+  Enabled: false
+
+Lint/ElseLayout:
+  Description: 'Check for odd code arrangement in an else block.'
+  Enabled: false
+
+Lint/FormatParameterMismatch:
+  Description: 'The number of parameters to format/sprint must match the fields.'
+  Enabled: false
+
+Lint/HandleExceptions:
+  Description: "Don't suppress exception."
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions'
+  Enabled: false
+
+Lint/LiteralAsCondition:
+  Description: 'Checks of literals used in conditions.'
+  Enabled: false
+
+Lint/LiteralInInterpolation:
+  Description: 'Checks for literals used in interpolation.'
+  Enabled: false
+
+Lint/Loop:
+  Description: >-
+                 Use Kernel#loop with break rather than begin/end/until or
+                 begin/end/while for post-loop tests.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#loop-with-break'
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Description: 'Do not use nested method definitions.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-nested-methods'
+  Enabled: false
+
+Lint/NonLocalExitFromIterator:
+  Description: 'Do not use return in iterator to cause non-local exit.'
+  Enabled: false
+
+Lint/ParenthesesAsGroupedExpression:
+  Description: >-
+                 Checks for method calls with a space before the opening
+                 parenthesis.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#parens-no-spaces'
+  Enabled: false
+
+Lint/RequireParentheses:
+  Description: >-
+                 Use parentheses in the method call to avoid confusion
+                 about precedence.
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Description: 'Do not use prefix `_` for a variable that is used.'
+  Enabled: false
+
+Lint/UnneededCopDisableDirective:
+  Description: >-
+                 Checks for rubocop:disable comments that can be removed.
+                 Note: this cop is not disabled when disabling all cops.
+                 It must be explicitly disabled.
+  Enabled: false
+
+Lint/Void:
+  Description: 'Possible use of operator/literal/variable in void context.'
+  Enabled: false
+
+# Performance
+
+Performance/CaseWhenSplat:
+  Description: >-
+                  Place `when` conditions that use splat at the end
+                  of the list of `when` branches.
+  Enabled: false
+
+Performance/Count:
+  Description: >-
+                  Use `count` instead of `select...size`, `reject...size`,
+                  `select...count`, `reject...count`, `select...length`,
+                  and `reject...length`.
+  Enabled: false
+
+Performance/Detect:
+  Description: >-
+                  Use `detect` instead of `select.first`, `find_all.first`,
+                  `select.last`, and `find_all.last`.
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerabledetect-vs-enumerableselectfirst-code'
+  Enabled: false
+
+Performance/FlatMap:
+  Description: >-
+                  Use `Enumerable#flat_map`
+                  instead of `Enumerable#map...Array#flatten(1)`
+                  or `Enumberable#collect..Array#flatten(1)`
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablemaparrayflatten-vs-enumerableflat_map-code'
+  Enabled: false
+
+Performance/ReverseEach:
+  Description: 'Use `reverse_each` instead of `reverse.each`.'
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#enumerablereverseeach-vs-enumerablereverse_each-code'
+  Enabled: false
+
+Performance/Sample:
+  Description: >-
+                  Use `sample` instead of `shuffle.first`,
+                  `shuffle.last`, and `shuffle[Fixnum]`.
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#arrayshufflefirst-vs-arraysample-code'
+  Enabled: false
+
+Performance/Size:
+  Description: >-
+                  Use `size` instead of `count` for counting
+                  the number of elements in `Array` and `Hash`.
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#arraycount-vs-arraysize-code'
+  Enabled: false
+
+Performance/StringReplacement:
+  Description: >-
+                  Use `tr` instead of `gsub` when you are replacing the same
+                  number of characters. Use `delete` instead of `gsub` when
+                  you are deleting characters.
+  Reference: 'https://github.com/JuanitoFatas/fast-ruby#stringgsub-vs-stringtr-code'
+  Enabled: false
+
+# Rails
+
+Rails/ActionFilter:
+  Description: 'Enforces consistent use of action filter methods.'
+  Enabled: false
+
+Rails/Date:
+  Description: >-
+                  Checks the correct usage of date aware methods,
+                  such as Date.today, Date.current etc.
+  Enabled: false
+
+Rails/FindBy:
+  Description: 'Prefer find_by over where.first.'
+  Enabled: false
+
+Rails/FindEach:
+  Description: 'Prefer all.find_each over all.find.'
+  Enabled: false
+
+Rails/HasAndBelongsToMany:
+  Description: 'Prefer has_many :through to has_and_belongs_to_many.'
+  Enabled: false
+
+Rails/Output:
+  Description: 'Checks for calls to puts, print, etc.'
+  Enabled: false
+
+Rails/ReadWriteAttribute:
+  Description: >-
+                 Checks for read_attribute(:attr) and
+                 write_attribute(:attr, val).
+  Enabled: false
+
+Rails/ScopeArgs:
+  Description: 'Checks the arguments of ActiveRecord scopes.'
+  Enabled: false
+
+Rails/TimeZone:
+  Description: 'Checks the correct usage of time zone aware methods.'
+  StyleGuide: 'https://github.com/bbatsov/rails-style-guide#time'
+  Reference: 'http://danilenko.org/2012/7/6/rails_timezones'
+  Enabled: false
+
+Rails/Validation:
+  Description: 'Use validates :attribute, hash of validations.'
+  Enabled: false

data/.travis.yml

@@ -2,6 +2,6 @@ sudo: false
 language: ruby
 rvm:
   - 2.5.0
-before_install: gem install bundler -v 1.16.1
+before_install: gem install bundler -v 1.16.3
 ignore:
   - spec/lib/object_serializer_performance.rb

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    lp-serializable (0.2.0)
+    lp-serializable (1.0.1)
       activesupport (>= 4.2)
-      fast_jsonapi (>= 1.2)
+      fast_jsonapi (>= 1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -48,13 +48,13 @@ GEM
     case_transform (0.2)
       activesupport
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.5)
     crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.7.1)
-    fast_jsonapi (1.2)
+    erubi (1.8.0)
+    fast_jsonapi (1.5)
       activesupport (>= 4.2)
-    i18n (1.0.1)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jsonapi-deserializable (0.2.0)
     jsonapi-rb (0.5.0)
@@ -65,19 +65,19 @@ GEM
       jsonapi-renderer (~> 0.2.0)
     jsonapi-serializers (1.0.1)
       activesupport
-    loofah (2.2.2)
+    loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.0)
-    mini_portile2 (2.3.0)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nokogiri (1.8.4)
-      mini_portile2 (~> 2.3.0)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
     oj (3.6.3)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.5)
+    rack (2.0.6)
     rack-test (1.0.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -128,4 +128,4 @@ DEPENDENCIES
   sqlite3 (~> 1.3)
 
 BUNDLED WITH
-   1.16.1
+   1.16.3

data/README.md

@@ -24,54 +24,61 @@ Or install it yourself as:
 
 ## Usage
 
-### Controller Definition
+**Controller Definition**
 
 ```ruby
 class ApplicationController < ActionController::Base
-    include Lp::Serializable
+  include Lp::Serializable
 end
 
 class MoviesController < ApplicationController
-    def index
-        movies = Movie.all
-        movies_hash = serialize_and_flatten_collection(movies, 'Movie')
-        render json: movies_hash
-    end
-
-    def show
-        movie = Movie.find(params[:id])
-        movie_hash = serialize_and_flatten(movie)
-        render json: movie
-    end
+  def index
+    movies = Movie.all
+    movies_hash = serializable_collection(movies, 'Movie')
+    render json: movies_hash
+  end
+
+  def show
+    movie = Movie.find(params[:id])
+    movie_hash = serializable(movie)
+    render json: movie_hash
+  end
 end
 ```
 
-### Serializer Definition
+**Serializer Definition**
 
 ```ruby
 class MovieSerializer
-    include FastJsonapi::ObjectSerializer
-
-    attributes :name, :year
-
-    has_many :actors
-    belongs_to :owner
+  include FastJsonapi::ObjectSerializer
+
+  attributes :name
+  
+  attribute :year, if: Proc.new { |object| object.year.present? }
+  
+  attribute :last_updated do |object|
+    object.updated_at
+  end
+
+  has_many :actors
+  belongs_to :owner
 end
 
 class ActorSerializer
-    include FastJsonapi::ObjectSerializer
+  include FastJsonapi::ObjectSerializer
     
-    attributes :id
+  attributes :id
 end
 
 class OwnerSerializer
-    include FastJsonapi::ObjectSerializer
+  include FastJsonapi::ObjectSerializer
 
-    attributes :id
+  attributes :id
 end
 ```
 
-### Sample Object
+## Object Serialization
+**Sample Object**
 
 ```ruby
 movie = Movie.new
@@ -83,14 +90,12 @@ movie.movie_type_id = 1
 movie
 ```
 
-### Object Serialization
-
-#### Return a hash
+**Return a hash**
 ```ruby
-hash = serialize_and_flatten(movie)
+hash = serializable(movie)
 ```
 
-#### Output
+**Output**
 
 ```json
 {
@@ -98,7 +103,7 @@ hash = serialize_and_flatten(movie)
     "id": "3",
     "type": "movie",
     "name": "test movie",
-    "year": null,
+    "last_updated": "2019-04-26 18:55:46 UTC",
     "actors": [
         {
             "id": "1",
@@ -120,11 +125,69 @@ hash = serialize_and_flatten(movie)
 
 For more information on configuration, refer to [fast_jsonapi](https://github.com/Netflix/fast_jsonapi#customizable-options) documentation.
 
+## Deeply Nested Serialization Pattern
+
+Fastjson API does not support serialization of deeply nested resources.
+
+To get around this, extend `Lp::Serializable` in your serializers:
+
+```ruby
+class MovieSerializer
+  include FastJsonapi::ObjectSerializer
+  extend Lp::Serializable
+
+ ...
+end
+```
+
+Define custom attributes for relationships, instead of defining them via fastjson_api:
+
+```ruby
+class MovieSerializer
+  include FastJsonapi::ObjectSerializer
+  extend Lp::Serializable
+
+ attribute :actors do |object|
+  collection = object.actors
+  serializer = 'Actor'
+  serializable_collection(collection, serializer, nested: true)
+ end
+end
+```
+
+Attribute `:actors` will trigger `ActorSerializer` to serialize the actors collection. Consequently, any relationships defined in `ActorSerializer` via custom attributes and serialized with `serializable_` methods (using the `nested: true` option) will be appropriately nested.
+
+## Custom Serializer Class
+
+Use `#serializable_class` to serialize with a custom class:
+
+```ruby
+  def show
+    movie = Movie.find(params[:id])
+    # Will serialize with FilmSerializer instead of MovieSerializer
+    movie_hash = serializable_class(movie, 'Film')
+    render json: movie_hash
+  end
+```
+
 ## Options Support
 
-lp-serializable does not currently support fast_jsonapi's options hash when instantiating serializers. 
+Supported options include:
+
+- `:fields` ([Sparse Fieldsets](https://github.com/Netflix/fast_jsonapi#sparse-fieldsets))
+- `:params` ([Params](https://github.com/Netflix/fast_jsonapi#params))
+- [Conditional Attributes](https://github.com/Netflix/fast_jsonapi#conditional-attributes)
+
+Other options are "supported" but may yeild unexpected results, as Serializable's hash flattening prioritizes deeply nested data structures.
+
+`:is_collection` is baked into Seriazable methods for accurate detection of collections or singular resources.
+
+## Aliases
+
+- `serialize_and_flatten()` = `serializable()`
+- `serialize_and_flatten_with_class_name()` = `serializable_class()`
+- `serialize_and_flatten_collection()` = `serializable_collection()`
 
-This affects serializing with [params](https://github.com/Netflix/fast_jsonapi#params), [compound documents](https://github.com/Netflix/fast_jsonapi#compound-document), metadata, and links.
 
 ## Development
 
@@ -134,7 +197,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lp-serializable. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/LaunchPadLab/lp-serializable. 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
 
@@ -142,4 +205,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Lp::Serializable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lp-serializable/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Lp::Serializable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/LaunchPadLab/lp-serializable/blob/master/CODE_OF_CONDUCT.md).

data/lib/fast_jsonapi/object_serializer.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/object'
 require 'active_support/concern'
 require 'active_support/inflector'
 require 'fast_jsonapi/serialization_core'
+require 'fast_jsonapi/attribute'
 
 module FastJsonapi
   module ObjectSerializer
@@ -149,11 +150,17 @@ module FastJsonapi
 
       def attributes(*attributes_list, &block)
         attributes_list = attributes_list.first if attributes_list.first.class.is_a?(Array)
+        options = attributes_list.last.is_a?(Hash) ? attributes_list.pop : {}
         self.attributes_to_serialize = {} if self.attributes_to_serialize.nil?
+        
         attributes_list.each do |attr_name|
           method_name = attr_name
           key = run_key_transform(method_name)
-          attributes_to_serialize[key] = block || method_name
+          attributes_to_serialize[key] = Attribute.new(
+            key: key,
+            method: block || method_name,
+            options: options
+          )
         end
       end
 

data/lib/fast_jsonapi/serialization_core.rb

@@ -73,12 +73,9 @@ module FastJsonapi
       end
 
       def attributes_hash(record, params = {})
-        attributes_to_serialize.each_with_object({}) do |(key, method), attr_hash|
-          attr_hash[key] = if method.is_a?(Proc)
-            method.arity == 1 ? method.call(record) : method.call(record, params)
-          else
-            record.public_send(method)
-          end
+        attributes = attributes_to_serialize
+        attributes.each_with_object({}) do |(_k, attribute), hash|
+          attribute.serialize(record, params, hash)
         end
       end
 

data/lib/lp/serializable.rb

@@ -1,33 +1,45 @@
 require "lp/serializable/strategies"
+require "lp/serializable/exceptions"
 
 module Lp
   module Serializable
     include Strategies
+    include Exceptions
 
-    class UnserializableCollection < StandardError
-      def initialize(msg='Expected an object, but a collection was given.')
-        super
-      end
-    end
-
-    def serialize_and_flatten(resource, options={})
-      base_hash = serialize_hash(resource)
+    def serialize_and_flatten(resource, options = {})
+      return { :data => nil }  if resource.nil? # Match the return of serializable_class when given nil
+      collection_option = collection?(false)
+      base_hash = serialize_hash(resource, options.merge(collection_option))
       flatten_and_nest_data(base_hash, set_nested_option(options))
     end
 
-    def serialize_and_flatten_with_class_name(resource, class_name, options={})
-      raise UnserializableCollection if resource.is_a?(Array) 
-      base_hash = serializable_hash_with_class_name(resource, 
-                                                    class_name, 
-                                                    options)
+    def serialize_and_flatten_with_class_name(
+      resource,
+      class_name,
+      options = {}
+    )
+      raise UnserializableCollection if resource.is_a?(Array)
+      collection_option = collection?(false)
+      base_hash = serializable_hash_with_class_name(
+        resource,
+        class_name,
+        options.merge(collection_option),
+      )
       flatten_and_nest_data(base_hash, set_nested_option(options))
     end
 
-    def serialize_and_flatten_collection(resource, class_name, options={})
-      base_hash = serializable_hash_with_class_name(resource, 
-                                                    class_name, 
-                                                    options)
+    def serialize_and_flatten_collection(resource, class_name, options = {})
+      collection_option = collection?(true)
+      base_hash = serializable_hash_with_class_name(
+        resource,
+        class_name,
+        options.merge(collection_option),
+      )
       flatten_array_and_nest_data(base_hash, set_nested_option(options))
     end
+
+    alias_method :serializable, :serialize_and_flatten
+    alias_method :serializable_class, :serialize_and_flatten_with_class_name
+    alias_method :serializable_collection, :serialize_and_flatten_collection
   end
-end
+end

data/lib/lp/serializable/exceptions.rb

@@ -0,0 +1,11 @@
+module Lp
+  module Serializable
+    module Exceptions
+      class UnserializableCollection < StandardError
+        def initialize(msg = "Expected an object, but a collection was given.")
+          super
+        end
+      end
+    end
+  end
+end

data/lib/lp/serializable/strategies.rb

@@ -9,14 +9,14 @@ module Lp
 
       private
 
-      def serialize_hash(resource, options={})
-        "#{resource.class.name}Serializer"
-          .constantize.new(resource, options).serializable_hash
+      def serialize_hash(resource, options = {})
+        "#{resource.class.name}Serializer".
+          constantize.new(resource, options).serializable_hash
       end
 
-      def serializable_hash_with_class_name(resource, class_name, options={})
-        "#{class_name}Serializer"
-          .constantize.new(resource, options).serializable_hash
+      def serializable_hash_with_class_name(resource, class_name, options = {})
+        "#{class_name}Serializer".
+          constantize.new(resource, options).serializable_hash
       end
 
       def flatten_and_nest_data(hash, nested)
@@ -26,10 +26,14 @@ module Lp
       def flatten_array_and_nest_data(hash, nested)
         nest_data?(flatten_array_of_hashes(expose_data(hash)), nested)
       end
-      
+
+      def collection?(boolean)
+        { is_collection: boolean }
+      end
+
       def set_nested_option(options)
         options.fetch(:nested, false)
       end
     end
   end
-end
+end

data/lib/lp/serializable/utilities.rb

@@ -3,7 +3,7 @@ module Lp
     module Utilities
       private
 
-      REDUNDANT_KEYS = %i(attributes relationships)
+      REDUNDANT_KEYS = %i[attributes relationships].freeze
 
       def nest_data?(resource, nested)
         if nested
@@ -35,27 +35,31 @@ module Lp
 
       def flatten_hash(hash)
         return unless hash
-        hash.each_with_object({}) do |(k, v), h|
-          if hash_and_matches_redundant_keys?(v, k)
-            flatten_hash(v).map do |h_k, h_v|
-              h[h_k.to_s.to_sym] = h_v
-            end
-          # NOTE: extract this into a different method?
-          elsif hash_and_has_data_key?(v)
-            h[k] = expose_data(v)
+        hash.each_with_object({}) do |(key, value), h|
+          if hash_and_matches_redundant_keys?(key, value)
+            flatten_hash_map(value, h)
+          elsif hash_and_has_data_key?(value)
+            h[key] = expose_data(value)
           else
-            h[k] = v
+            h[key] = value
           end
         end
       end
 
+      def flatten_hash_map(value, hash)
+        flatten_hash(value).map do |h_k, h_v|
+          hash[h_k.to_s.to_sym] = h_v
+        end
+      end
+
       def hash_and_has_data_key?(value)
         value.is_a?(Hash) && value.key?(:data)
       end
 
-      def hash_and_matches_redundant_keys?(value, key)
-        value.is_a?(Hash) && REDUNDANT_KEYS.any?{|sym| sym == key}
+      # NOTE Supports native relationship references in serializer
+      def hash_and_matches_redundant_keys?(key, value)
+        value.is_a?(Hash) && REDUNDANT_KEYS.any? { |sym| sym == key }
       end
     end
   end
-end
+end

data/lib/lp/serializable/version.rb

@@ -1,5 +1,5 @@
 module Lp
   module Serializable
-    VERSION = "0.2.0"
+    VERSION = "1.0.1"
   end
-end
+end

data/lp-serializable.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["mrjonesbot"]
   spec.email         = ["nate@mrjones.io"]
 
-  spec.summary       = "Serialize with Fast JSON API, flatten like AWS"
+  spec.summary       = "Serialize with Fast JSON API, flatten like AMS"
   spec.description   = "JSON API(jsonapi.org) serializer wrapper methods that work with Rails and can be used to serialize any kind of ruby object with AMS style output."
   spec.homepage      = "https://www.github.com/launchpadlab/lp-serializable"
   spec.license       = "MIT"
@@ -45,5 +45,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency(%q<activesupport>, [">= 4.2"])
   spec.add_development_dependency(%q<byebug>, [">= 0"])
 
-  spec.add_dependency "fast_jsonapi", '>= 1.2'
-end
+  spec.add_dependency "fast_jsonapi", '>= 1.3'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lp-serializable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.1
 platform: ruby
 authors:
 - mrjonesbot
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-14 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 description: JSON API(jsonapi.org) serializer wrapper methods that work with Rails
   and can be used to serialize any kind of ruby object with AMS style output.
 email:
@@ -230,6 +230,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -244,6 +245,7 @@ files:
 - lib/fast_jsonapi/object_serializer.rb
 - lib/fast_jsonapi/serialization_core.rb
 - lib/lp/serializable.rb
+- lib/lp/serializable/exceptions.rb
 - lib/lp/serializable/strategies.rb
 - lib/lp/serializable/utilities.rb
 - lib/lp/serializable/version.rb
@@ -271,5 +273,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Serialize with Fast JSON API, flatten like AWS
+summary: Serialize with Fast JSON API, flatten like AMS
 test_files: []