sbf-dm-serializer 1.3.0.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 395f26406e9c74af2d407afc259314e46210404d7b192d93710e9de4435cd339
+  data.tar.gz: 60723bbec20f293920e941ae63af510d3ebec41cd87de40281c1bdad46714dcc
+SHA512:
+  metadata.gz: b18fb6825c10139930a87daac0bbb272904d28e3a2351e70d2d4aaee712f5413e7daae8dacc0fcf8e7ea2fea343b644783996493c65c3244901de0fa1870b97e
+  data.tar.gz: 440b2db6c25ccf72f444e880949bba56bde19d061b80e79fd9b4d9fdfe50ea2eccbbf13ab20f1cf02494e3e5ead128bf270fa70c76bb17a17e3f34d6a273eb1c

data/.gitignore

@@ -0,0 +1,38 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+
+## RubyMine
+.idea
+
+## PROJECT::GENERAL
+*.gem
+coverage
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.*
+
+## PROJECT::SPECIFIC
+spec/db/

data/.rspec

@@ -0,0 +1,5 @@
+--colour
+--order rand
+--format documentation
+--profile
+--backtrace

data/.rubocop.yml

@@ -0,0 +1,468 @@
+#require: rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
+
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: false
+
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+
+Lint/EmptyFile:
+  Enabled: true
+
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+
+Lint/ItWithoutArgumentsInBlock: # new in 1.59
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+
+Lint/LiteralAssignmentInCondition: # new in 1.58
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedCaseRange: # new in 1.53
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: false
+
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+
+Lint/RedundantRegexpQuantifiers: # new in 1.53
+  Enabled: true
+
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+
+Lint/SafeNavigationChain:
+  Enabled: true
+  AllowedMethods:
+    - present?
+    - blank?
+    - presence
+    - try
+    - try!
+    - empty?
+    - nil?
+    - blank?
+
+Lint/SymbolConversion:
+  Enabled: false
+
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  AllowedNames: [a, _, id]
+
+Naming/VariableNumber:
+  Enabled: true
+#  EnforcedStyle: snake_case
+
+#Performance/CollectionLiteralInLoop:
+#  Enabled: true
+#
+#Performance/RangeInclude:
+#  Enabled: false
+#
+#Performance/RedundantEqualityComparisonBlock:
+#  Enabled: true
+
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+
+Security/IoMethods: # new in 1.22
+  Enabled: true
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/Alias:
+  Enabled: false
+  EnforcedStyle: prefer_alias_method
+
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+
+Style/EnvHome: # new in 1.29
+  Enabled: true
+
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+
+Style/FetchEnvVar:
+  Enabled: true
+
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+
+Style/FileRead: # new in 1.24
+  Enabled: true
+
+Style/FileWrite: # new in 1.24
+  Enabled: true
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashConversion: # new in 1.10
+  Enabled: true
+
+Style/HashExcept: # new in 1.7
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: consistent
+
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+
+Style/MapToHash: # new in 1.24
+  Enabled: true
+
+Style/MapToSet: # new in 1.42
+  Enabled: true
+
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+
+Style/MixinGrouping:
+  Enabled: true
+  EnforcedStyle: grouped
+
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+
+Style/NilLambda: # new in 1.3
+  Enabled: true
+
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+
+Style/OpenStructUse:
+  Enabled: false
+
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%i': '()'
+    '%I': '()'
+    '%r': '{}'
+    '%w': '()'
+    '%W': '()'
+
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+
+Style/RedundantCurrentDirectoryInPath: # new in 1.53
+  Enabled: true
+
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+
+Style/RedundantParentheses:
+  Enabled: true
+
+Style/RedundantRegexpArgument: # new in 1.53
+  Enabled: true
+
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: true
+  EnforcedStyle: mixed
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/ReturnNilInPredicateMethodDefinition: # new in 1.53
+  Enabled: true
+
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SingleLineDoEndBlock: # new in 1.57
+  Enabled: true
+
+Style/StringChars: # new in 1.12
+  Enabled: true
+
+Style/SuperWithArgsParentheses: # new in 1.58
+  Enabled: true
+
+Style/SwapValues: # new in 1.1
+  Enabled: true
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+Style/YAMLFileRead: # new in 1.53
+  Enabled: true

data/Gemfile

@@ -0,0 +1,80 @@
+require 'pathname'
+
+source 'https://rubygems.org'
+
+gemspec
+
+SOURCE         = ENV.fetch('SOURCE', :git).to_sym
+REPO_POSTFIX   = (SOURCE == :path) ? '' : '.git'
+DATAMAPPER     = (SOURCE == :path) ? Pathname(__FILE__).dirname.parent : 'https://github.com/firespring'
+DM_VERSION     = '~> 1.3.0.beta'.freeze
+DO_VERSION     = '~> 0.10.17'.freeze
+DM_DO_ADAPTERS = %w(sqlite postgres mysql oracle sqlserver).freeze
+CURRENT_BRANCH = ENV.fetch('GIT_BRANCH', 'master')
+
+options = {}
+options[SOURCE] = "#{DATAMAPPER}/dm-core#{REPO_POSTFIX}"
+options[:branch] = CURRENT_BRANCH unless SOURCE == :path
+gem 'sbf-dm-core', DM_VERSION, options.dup
+
+gem 'fastercsv',  '~> 1.5.4'
+gem 'json',       '~> 2.7', platforms: %i(ruby_18 jruby)
+gem 'multi_json'
+gem 'rexml'
+
+group :development do
+  options[SOURCE] = "#{DATAMAPPER}/dm-validations#{REPO_POSTFIX}"
+  gem 'sbf-dm-validations', DM_VERSION, options.dup
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'rake'
+  gem 'rspec'
+  gem 'simplecov'
+end
+
+group :testing do
+  gem 'libxml-ruby', '~> 5.0', platforms: %i(mri mswin)
+  gem 'nokogiri',    '~> 1.15'
+end
+
+platforms :mri_18 do
+  group :quality do
+    gem 'yard'
+    gem 'yardstick'
+  end
+end
+
+group :datamapper do
+  adapters = ENV['ADAPTER'] || ENV.fetch('ADAPTERS', nil)
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w(in_memory)
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    do_options = {}
+    if ENV['DO_GIT'] == 'true'
+      do_options = options.dup
+      do_options[SOURCE] = "#{DATAMAPPER}/datamapper-do#{REPO_POSTFIX}"
+    end
+    gem 'sbf-data_objects', DO_VERSION, do_options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "sbf-do_#{adapter}", DO_VERSION, do_options.dup
+    end
+
+    options[SOURCE] = "#{DATAMAPPER}/dm-do-adapter#{REPO_POSTFIX}"
+    gem 'sbf-dm-do-adapter', DM_VERSION, options.dup
+  end
+
+  adapters.each do |adapter|
+    options[SOURCE] = "#{DATAMAPPER}/dm-#{adapter}-adapter#{REPO_POSTFIX}"
+    gem "sbf-dm-#{adapter}-adapter", DM_VERSION, options.dup
+  end
+
+  plugins = ENV['PLUGINS'] || ENV.fetch('PLUGIN', nil)
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+    options[SOURCE] = "#{DATAMAPPER}/#{plugin}#{REPO_POSTFIX}"
+    gem "sbf-#{plugin}", DM_VERSION, options.dup
+  end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Guy van den Berg
+
+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.rdoc

@@ -0,0 +1,64 @@
+= dm-serializer
+
+== Overview
+
+dm-serializer allows DataMapper models and collections to be serialized to a variety of formats (currently JSON, XML, YAML and CSV).
+
+== How it works
+
+One method is added to each model/collection for each serialization type - <tt>to_json</tt>, <tt>to_xml</tt>, <tt>to_yaml</tt>, and <tt>to_csv</tt>. With the exception of <tt>to_csv</tt>, all of these methods share the same interface. <tt>to_json</tt> will be used for examples. Any method specific behaviour is documented in its own section below.
+
+  require 'dm-serializer'
+
+  class Cow
+    include DataMapper::Resource
+
+    property :id,   Integer, :key => true
+    property :name, String
+
+    def description
+      "A Cow"
+    end
+  end
+
+  cow = Cow.create(
+    :id    => 1,
+    :name  => "Berta"
+  )
+
+  cow.to_json                      # => { "id": 1, "name": "Berta" }
+  cow.to_json(:only    => [:name]) # => { "name": "Berta" }
+  cow.to_json(:exclude => [:id])   # => { "name": "Berta" }
+  cow.to_json(:methods => [:description]) # => { "id": 1, "name": "Berta", "description": "A Cow" }
+
+You can include associations by passing the association accessor the <tt>:methods</tt> option.
+
+If you want to only load a particular serialization method, that's cool, you can do that:
+
+  require 'dm-serializer/to_json'
+
+== to_xml
+
+<tt>to_xml</tt> supports some extra options to allow you to override the element names
+
+  cow.to_xml(:element_name => 'bovine') # => <bovine><id>1</id><name>Berta</name></bovine>
+  cows.to_xml(:collection_element_name => 'kine')   # => <kine><bovine><id>1</id><name>Berta</name></bovine></kine>
+
+
+If you would like a nice speed boost (~5x), require <tt>libxml</tt> or <tt>nokogiri</tt> before <tt>dm-serializer</tt>, and that library will be used rather than REXML.
+
+== to_csv
+
+<tt>to_csv</tt> currently doesn't support any options yet. It will in the future. It will not support serializing child associations.
+
+
+== Arrays, Hashes, and other core classes
+
+<tt>dm-serializer</tt> only adds serialization methods to DataMapper objects and collections, however some libraries used (json, yaml) add methods to core classes, such as <tt>Array</tt>. Note that passing <tt>dm-serializer</tt> options (such as <tt>:only</tt>) to these methods is *not supported*.
+
+  Cow.all.to_a.to_yaml(:only => 'name') # WILL NOT WORK
+
+
+== Beware
+
+If you go spelunking through the code you will find other undocumented options. Use at your own risk, I plan on removing or changing these in the near future.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+
+FileList['tasks/**/*.rake'].each { |task| import task }