graphql-mutable_type 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7eb86c208db7e5a2c2bb14382001fa22d278091
+  data.tar.gz: 0be68339b26d0d61b5f9b2a7e262edf92f6ddf9e
+SHA512:
+  metadata.gz: 2f8a92d7844f6900426b59bd02bfea7260ae57b0c4ffbabcb02800f020003ea47a6eaa0ca4893a98e0c642d0ca7ffa95bfba581d1624779b26edeab01c0acd8a
+  data.tar.gz: 0f0098d0b5eaeafe909bf9bbc1ff38c5e20d6548275acf5432d7a57c2223d1eee9bc4e6e95747d9381b216be0d422396608bab60db6006c3ecbfd7d9cc836d3b

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - "2.2"
+  - "2.1"
+  - "rbx-2"

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    graphql-mutable_type (0.0.1)
+      graphql (~> 0.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    blankslate (3.1.3)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    graphql (0.10.9)
+      parslet (~> 1.6)
+    json (1.8.3)
+    method_source (0.8.2)
+    parslet (1.7.1)
+      blankslate (>= 2.0, <= 4.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.2)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 0.4)
+  graphql-mutable_type!
+  pry (~> 0.10)
+  rake (~> 10.4)
+  rspec (~> 3.4)
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 CBN New Media Technology Co. Ltd
+
+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,70 @@
+## GraphQL::MutableType
+
+GraphQL::MutableType is an extension to GraphQL::ObjectType that adds the ability of having nested mutation queries.
+It defines as following:
+
+```
+type Fish {
+  id: String
+  name: String
+  Price: Float
+  inStock: Int
+  mutation: [FishMutation]
+}
+```
+
+```
+type FishMutation {
+  update: [UpdateFishMutation]
+  sell: [SellFishMutation]
+}
+```
+
+And can be queried as following:
+
+```
+query {
+  fish(id: "1") {
+    id
+    name
+    price
+    mutation {
+      sell(weight: 100) {
+        inStock
+      }
+    }
+  }
+}
+```
+
+## Proposal
+
+As working with Facebook's practice of GraphQL, we have found that the mutations are all top level children of "mutation". This keeps us using global mutation names look like "SellFish", "UpdateFish". While all the models and services are coded in the OO way, the organization of mutations reminds me of days with out OO: some structs and a large set of functions that operate on the structs.
+
+So we tried to reorganize the mutations under the Object Type itself, whick looks more like the way models we define our models.
+
+This gem provides a DSL that helps define the types with mutations inside.
+
+## Usage
+
+Just warp your mutations in ```mutation do ... end```.
+
+```ruby
+KingType = GraphQL::MutableType.define do
+  name 'King'
+  description 'The title of the ruler of the kingdom'
+
+  field :id,   !types.ID
+  field :name, !types.String
+
+  mutation do
+    field :rename, field: RenameKingField
+  end
+end
+```
+
+See alse: [test schema](spec/support/francia_kings_app.rb)
+
+## License
+
+This gem is released under the [MIT License](MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/graphql-mutable_type.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'graphql'
+require 'graphql/mutable_type/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'graphql-mutable_type'
+  gem.version     = GraphQL::MutableType::VERSION
+  gem.date        = Date.today.to_s
+  gem.summary     = 'An Object Type that may have mutation queries.'
+  gem.description = 'An Object Type that may have mutation queries.'
+  gem.homepage    = 'https://github.com/TapasTech/graphql-mutable_type'
+  gem.authors     = ['Karloku Sang']
+  gem.email       = ['karloku@gmail.com']
+  gem.license     = 'MIT'
+  gem.required_ruby_version = '>= 2.1.0' # bc optional keyword args
+
+  gem.require_paths = ['lib']
+  gem.files         = Dir['{lib}/**/*', 'MIT-LICENSE', 'README.md']
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+
+  gem.add_dependency 'graphql', '~> 0.10.0'
+
+  gem.add_development_dependency 'codeclimate-test-reporter', '~>0.4'
+  gem.add_development_dependency 'pry', '~> 0.10'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'rake', '~> 10.4'
+end

data/lib/graphql/mutable_type/defined_by_config.rb

@@ -0,0 +1,28 @@
+# Define MutableType by define block
+class GraphQL::DefinitionHelpers::DefinedByConfig::DefinitionConfig
+  attr_definable :mutation
+
+  def mutation(&block)
+    mutation_type = mutation_type(&block)
+
+    field :mutation do
+      name 'mutation'
+      type mutation_type
+      description mutation_type.description
+
+      resolve -> (obj, _args, _cxt) { obj }
+    end
+  end
+
+  protected
+
+  # define nested mutation type
+  def mutation_type(&block)
+    @mutation_type ||= begin
+      m_type = GraphQL::ObjectType.define(&block)
+      m_type.name = "#{name} Mutation"
+      m_type.description = "Mutations of #{description}"
+      m_type
+    end
+  end
+end

data/lib/graphql/mutable_type/version.rb

@@ -0,0 +1,5 @@
+module GraphQL
+  class MutableType < ObjectType
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/graphql/mutable_type.rb

@@ -0,0 +1,11 @@
+module GraphQL
+  # Mutable Type is an extended Object Type that has mutations inside.
+  class MutableType < ObjectType
+    defined_by_config(*superclass.defined_by_config, :mutation)
+
+    attr_accessor :mutation
+  end
+end
+
+require 'graphql/mutable_type/defined_by_config'
+# require 'graphql/mutable_type/version'

data/lib/graphql-mutable_type.rb

@@ -0,0 +1,2 @@
+require 'graphql'
+require 'graphql/mutable_type'

data/spec/graphql/mutable_type_spec.rb

@@ -0,0 +1,64 @@
+RSpec.describe GraphQL::MutableType do
+  let(:king_france) { KINGS['k_france'] }
+  let(:king_germany) { KINGS['k_germany'] }
+  let(:king_lotharingia) { KINGS['k_lotharingia'] }
+
+  let(:type) { KingType }
+  let(:schema) { FranciaSchema }
+  describe 'define mutable type' do
+    
+    let(:mutation) { type.fields['mutation'] }
+    let(:mutation_fields) { mutation.type.fields }
+
+    it 'has mutation' do
+      expect(mutation).to be_truthy
+      expect(mutation_fields.keys).to eq(%w(rename))
+    end
+
+    let(:resolve) { ->(id) { mutation.resolve(id, nil, nil) } }
+
+    it 'resolve mutation results the object it self' do
+      expect(resolve[king_france]).to eq(king_france)
+      expect(resolve[king_germany]).to eq(king_germany)
+      expect(resolve[king_lotharingia]).to eq(king_lotharingia)
+    end
+  end
+
+  describe 'execute query with mutation' do
+    let(:query) do
+%q{
+  query {
+    king(id: "k_germany") {
+      id
+      name
+      mutation {
+        rename(name: "Germany") {
+          name
+        }
+      }
+    }
+  }
+}
+    end
+
+    let(:result) do
+      {
+        "data" => {
+          "king" => {
+            "id" => "k_germany",
+            "name" => "East Francia",
+            "mutation" => {
+              "rename" => {
+                "name" => "Germany"
+              }
+            }
+          }
+        }
+      } 
+    end
+
+    it 'renames East Francia to Germany' do      
+      expect(schema.execute(query)).to eq(result)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'bundler/setup'
+Bundler.setup
+
+require 'pry'
+require 'graphql-mutable_type'
+require File.join(File.dirname(__FILE__), 'support/francia_kings_app.rb')
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/francia_kings_app.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'francia_kings_data.rb')
+
+RenameKingField = GraphQL::Field.define do
+  type -> { KingType }
+
+  argument :name, !types.String
+
+  resolve ->(obj, args, _cxt) { (obj.name = args[:name]) && obj }
+end
+
+FetchKingField = GraphQL::Field.define do
+  type -> { KingType }
+
+  argument :id, !types.ID
+
+  resolve ->(_obj, args, _cxt) { KINGS[args[:id]] }
+end
+
+KingType = GraphQL::MutableType.define do
+  name 'King'
+  description 'The title of the ruler of the kingdom'
+
+  field :id,   !types.ID
+  field :name, !types.String
+
+  mutation do
+    field :rename, field: RenameKingField
+  end
+end
+
+QueryType = GraphQL::ObjectType.define do
+  name 'Query'
+  description 'Query root'
+
+  field :king, field: FetchKingField
+end
+
+FranciaSchema = GraphQL::Schema.new(query: QueryType)

data/spec/support/francia_kings_data.rb

@@ -0,0 +1,7 @@
+King = Struct.new(:id, :name, :king)
+
+KINGS = {
+  'k_france' => King.new('k_france', 'West Francia'),
+  'k_lotharingia' => King.new('k_lotharingia', 'Middle Francia'),
+  'k_germany' => King.new('k_germany', 'East Francia')
+}.freeze

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: graphql-mutable_type
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Karloku Sang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: graphql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: An Object Type that may have mutation queries.
+email:
+- karloku@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- graphql-mutable_type.gemspec
+- lib/graphql-mutable_type.rb
+- lib/graphql/mutable_type.rb
+- lib/graphql/mutable_type/defined_by_config.rb
+- lib/graphql/mutable_type/version.rb
+- spec/graphql/mutable_type_spec.rb
+- spec/spec_helper.rb
+- spec/support/francia_kings_app.rb
+- spec/support/francia_kings_data.rb
+homepage: https://github.com/TapasTech/graphql-mutable_type
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.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: An Object Type that may have mutation queries.
+test_files: []