trav3 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed23a93da595b3da695cb6caab54e75c06f8b0dad48f9765293a21698fe1893b
-  data.tar.gz: c6ca0a3472f8130457a2aadccdf757bfc4e8ba12c4ce43cc5bedf2e781c7a050
+  metadata.gz: b79ebdae779f99cce1a1ce93943918f211eeaba5d8ad67eeab8afd67af5212ce
+  data.tar.gz: '09df80099c63c1472d782d3829e4b53c8ef4be1241e7e0bbefbd62b3d9d6b727'
 SHA512:
-  metadata.gz: 57991342eb7e718ba0e4441a901e7765fd2bb19159eda1e124c2e214c86e60a7ee3a040ab931a8e5829c674035522126bfcaeb7f671570876baa9a5bc9414ea2
-  data.tar.gz: 235cbd08b2ec78926a8a142653ca98441c8063904e5686a37bf08d308c5c9495e9778023d9e8c5aac862b0ba9714f4d412e199474c7f29297297ef00899bf8b6
+  metadata.gz: 7f552afb48039f584aa92c38cd5b1e078ca4e5ffe66c07c93b6dbcabc891be092b89e17c2afd6e02290359990f6d612d145e50ceab13829086c738a785443e77
+  data.tar.gz: 3b6ed188c1a2240cc712f3c79617b078f881aafe32fdfe8956f62c505eb9b93ac90dbedaa68f470347d70cefb3526772741a2a90ec3b102657732d2b85ef8f0a

data/.codeclimate.yml

@@ -6,7 +6,3 @@ checks:
   method-count:
     config:
       threshold: 100
-
-plugins:
-  rubocop:
-    enabled: true

data/README.md

@@ -1,6 +1,6 @@
 [![Gem Version](https://badge.fury.io/rb/trav3.svg)](http://badge.fury.io/rb/trav3)
 [![Build Status](https://travis-ci.org/danielpclark/trav3.svg?branch=master)](https://travis-ci.org/danielpclark/trav3)
-[![Commits Since Release](https://img.shields.io/github/commits-since/danielpclark/trav3/v0.3.4.svg)](https://github.com/danielpclark/trav3/graphs/commit-activity)
+[![Commits Since Release](https://img.shields.io/github/commits-since/danielpclark/trav3/v0.4.0.svg)](https://github.com/danielpclark/trav3/graphs/commit-activity)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1ed07a4baea3832b6207/maintainability)](https://codeclimate.com/github/danielpclark/trav3/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/1ed07a4baea3832b6207/test_coverage)](https://codeclimate.com/github/danielpclark/trav3/test_coverage)
 [![Red The Docs](https://img.shields.io/badge/Read-the%20docs-blue.svg)](http://danielpclark.github.io/trav3/Trav3/Travis.html)
@@ -31,32 +31,93 @@ Or install it yourself as:
 
 ## Usage
 
-    require 'trav3'
-    project = Trav3::Travis.new("name/example")
-    project.owner
-    project.owner("owner")
-    project.repositories
-    project.repositories("owner")
-    project.repository
-    project.repository("owner/repo")
-    project.builds
-    project.build(12345)
-    project.build_jobs(12345)
-    project.job(1234)
-    project.log(1234)
-    
-    # API Request Options
-    project.defaults(limit: 25)
-    
-    # Pagination
-    builds = project.builds
-    builds.page.next
-    builds.page.first
-    builds.page.last
-    
-    # Recommended inspection
-    builds.keys
-    builds.dig("some_key")
+You can get started with the following.
+
+```ruby
+require 'trav3'
+project = Trav3::Travis.new("name/example")
+```
+
+When you instantiate an instance of [Trav3::Travis](http://danielpclark.github.io/trav3/Trav3/Travis.html)
+you get some default headers and default options.
+
+#### Default Options
+
+* `limit: 25` — for limiting data queries to 25 items at most
+
+Options can be changed via the `#options` getter method which will give you a
+[Trav3::Options](http://danielpclark.github.io/trav3/Trav3/Options.html) instance.
+All changes to it affect the options that the `Trav3::Travis` instance will submit
+in url requests.
+
+#### Default Headers
+
+* `'Content-Type': 'application/json'`
+* `'Accept': 'application/json'`
+* `'Travis-API-Version': 3`
+
+Headers can be changed via the `#headers` getter method which will give you a
+[Trav3::Headers](http://danielpclark.github.io/trav3/Trav3/Headers.html) instance.
+All changes to it affect the headers that the `Trav3::Travis` instance will submit
+in url requests.
+
+## API
+
+The client has the full API implemented.  Here are the methods.
+
+| | | |
+|-----|-----|-----|
+| [`#active`](http://danielpclark.github.io/trav3/Trav3/Travis.html#active-instance_method) | [`#beta_feature`](http://danielpclark.github.io/trav3/Trav3/Travis.html#beta_feature-instance_method) | [`#beta_features`](http://danielpclark.github.io/trav3/Trav3/Travis.html#beta_features-instance_method) |
+| [`#branch`](http://danielpclark.github.io/trav3/Trav3/Travis.html#branch-instance_method) | [`#branches`](http://danielpclark.github.io/trav3/Trav3/Travis.html#branches-instance_method) | [`#broadcasts`](http://danielpclark.github.io/trav3/Trav3/Travis.html#broadcasts-instance_method) |
+| [`#build`](http://danielpclark.github.io/trav3/Trav3/Travis.html#build-instance_method) | [`#builds`](http://danielpclark.github.io/trav3/Trav3/Travis.html#builds-instance_method) | [`#build_jobs`](http://danielpclark.github.io/trav3/Trav3/Travis.html#build_jobs-instance_method) |
+| [`#caches`](http://danielpclark.github.io/trav3/Trav3/Travis.html#caches-instance_method) | [`#cron`](http://danielpclark.github.io/trav3/Trav3/Travis.html#cron-instance_method) | [`#crons`](http://danielpclark.github.io/trav3/Trav3/Travis.html#crons-instance_method) |
+| [`#email_resubscribe`](http://danielpclark.github.io/trav3/Trav3/Travis.html#email_resubscribe-instance_method) | [`#email_unsubscribe`](http://danielpclark.github.io/trav3/Trav3/Travis.html#email_unsubscribe-instance_method) | [`#env_var`](http://danielpclark.github.io/trav3/Trav3/Travis.html#env_var-instance_method) |
+| [`#env_vars`](http://danielpclark.github.io/trav3/Trav3/Travis.html#env_vars-instance_method) | [`#installation`](http://danielpclark.github.io/trav3/Trav3/Travis.html#installation-instance_method) | [`#job`](http://danielpclark.github.io/trav3/Trav3/Travis.html#job-instance_method) |
+| [`#key_pair`](http://danielpclark.github.io/trav3/Trav3/Travis.html#key_pair-instance_method) | [`#key_pair_generated`](http://danielpclark.github.io/trav3/Trav3/Travis.html#key_pair_generated-instance_method) | [`#lint`](http://danielpclark.github.io/trav3/Trav3/Travis.html#lint-instance_method) |
+| [`#log`](http://danielpclark.github.io/trav3/Trav3/Travis.html#log-instance_method) | [`#messages`](http://danielpclark.github.io/trav3/Trav3/Travis.html#messages-instance_method) | [`#organization`](http://danielpclark.github.io/trav3/Trav3/Travis.html#organization-instance_method) |
+| [`#organizations`](http://danielpclark.github.io/trav3/Trav3/Travis.html#organizations-instance_method) | [`#owner`](http://danielpclark.github.io/trav3/Trav3/Travis.html#owner-instance_method) | [`#preference`](http://danielpclark.github.io/trav3/Trav3/Travis.html#preference-instance_method) |
+| [`#preferences`](http://danielpclark.github.io/trav3/Trav3/Travis.html#preferences-instance_method) | [`#repositories`](http://danielpclark.github.io/trav3/Trav3/Travis.html#repositories-instance_method) | [`#repository`](http://danielpclark.github.io/trav3/Trav3/Travis.html#repository-instance_method) |
+| [`#request`](http://danielpclark.github.io/trav3/Trav3/Travis.html#request-instance_method) | [`#requests`](http://danielpclark.github.io/trav3/Trav3/Travis.html#requests-instance_method) | [`#stages`](http://danielpclark.github.io/trav3/Trav3/Travis.html#stages-instance_method) |
+| [`#setting`](http://danielpclark.github.io/trav3/Trav3/Travis.html#setting-instance_method) | [`#settings`](http://danielpclark.github.io/trav3/Trav3/Travis.html#settings-instance_method) | [`#user`](http://danielpclark.github.io/trav3/Trav3/Travis.html#user-instance_method) |
+
+
+**General Usage**
+
+```ruby
+project.owner
+project.owner("owner")
+project.repositories
+project.repositories("owner")
+project.repository
+project.repository("owner/repo")
+project.builds
+project.build(12345)
+project.build_jobs(12345)
+project.job(1234)
+project.log(1234)
+
+# API Request Options
+project.options.build({limit: 25})
+
+# Pagination
+builds = project.builds
+builds.page.next
+builds.page.first
+builds.page.last
+
+# Recommended inspection
+builds.keys
+builds.dig("some_key")
+```
+
+#### Follow
+
+Each request returns a `Trav3::Response` type of either `Trav3::Success` or `Trav3::RequestError`.
+When you have an instance of `Trav3::Success` each response collection of either `Hash` or `Array` will
+be an instance of `Trav3::ResponseCollection`.  If the `#hash?` method responds as `true` the `#follow`
+method will follow any immediate `@href` link provided in the collection.  If `#hash?` produces `false`
+then the collection is an Array of items and you may use the index of the item you want to follow the
+`@href` with; like so `#follow(3)`.
 
 ## Development
 

data/lib/trav3.rb

@@ -37,28 +37,23 @@ module Trav3
 
       initial_defaults
     end
-    # rubocop:disable Lint/Void
 
     # Set as the API endpoint
     #
     # @param endpoint [String] name for value to set
-    # @return [self]
+    # @return [Travis]
     def api_endpoint=(endpoint)
       validate_api_endpoint endpoint
-
       @api_endpoint = endpoint
-
-      self
     end
 
     # Set the authorization token in the requests' headers
     #
     # @param token [String] sets authorization token header
-    # @return [self]
+    # @return [Travis]
     def authorization=(token)
       validate_string token
       h('Authorization': "token #{token}")
-      self
     end
 
     # Set as many options as you'd like for collections queried via an API request
@@ -66,7 +61,7 @@ module Trav3
     # @overload defaults(key: value, ...)
     #   @param key [Symbol] name for value to set
     #   @param value [Symbol, String, Integer] value for key
-    # @return [self]
+    # @return [Travis]
     def defaults(**args)
       (@options ||= Options.new).build(args)
       self
@@ -79,7 +74,7 @@ module Trav3
     # @overload h(key: value, ...)
     #   @param key [Symbol] name for value to set
     #   @param value [Symbol, String, Integer] value for key
-    # @return [self]
+    # @return [Travis]
     def h(**args)
       (@headers ||= Headers.new).build(args)
       self
@@ -88,13 +83,11 @@ module Trav3
     # Change the repository this instance of `Trav3::Travis` uses.
     #
     # @param repo_name [String] github_username/repository_name
-    # @return [self]
+    # @return [Travis]
     def repository=(repo_name)
       validate_repo_format repo_name
       @repo = sanitize_repo_name repo_name
-      self
     end
-    # rubocop:enable Lint/Void
 
     # Please Note that the naming of this endpoint may be changed. Our naming convention for this information is in flux. If you have suggestions for how this information should be presented please leave us feedback by commenting in this issue here or emailing support support@travis-ci.com.
     #
@@ -154,6 +147,102 @@ module Trav3
       get("#{without_repo}/owner/#{owner}/active")
     end
 
+    # A beta feature (a Travis-CI feature currently in beta).
+    #
+    # ## Attributes
+    #
+    #     Name          Type     Description
+    #     id            Integer  Value uniquely identifying the beta feature.
+    #     name          String   The name of the feature.
+    #     description   String   Longer description of the feature.
+    #     enabled       Boolean  Indicates if the user has this feature turned on.
+    #     feedback_url  String   Url for users to leave Travis CI feedback on this feature.
+    #
+    # ## Actions
+    #
+    # **Update**
+    #
+    # This will update a user's beta_feature.
+    #
+    # Use namespaced params in the request body to pass the `enabled` value (either true or false):
+    #
+    # ```bash
+    # curl -X PATCH \
+    #   -H "Content-Type: application/json" \
+    #   -H "Travis-API-Version: 3" \
+    #   -H "Authorization: token xxxxxxxxxxxx" \
+    #   -d '{"beta_feature.enabled":true}' \
+    #   https://api.travis-ci.com/user/1234/{beta_feature.id}
+    # ```
+    #
+    # PATCH <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
+    #
+    #     Template Variable     Type     Description
+    #     user.id               Integer  Value uniquely identifying the user.
+    #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
+    #     Accepted Parameter    Type     Description
+    #     beta_feature.id       Integer  Value uniquely identifying the beta feature.
+    #     beta_feature.enabled  Boolean  Indicates if the user has this feature turned on.
+    #
+    # **Delete**
+    #
+    # This will delete a user's beta feature.
+    #
+    # DELETE <code>/user/{user.id}/beta_feature/{beta_feature.id}</code>
+    #
+    #     Template Variable  Type     Description
+    #     user.id            Integer  Value uniquely identifying the user.
+    #     beta_feature.id    Integer  Value uniquely identifying the beta feature.
+    #
+    # @param action [Symbol] either `:enable`, `:disable` or `:delete`
+    # @param beta_feature_id [String, Integer] id for the beta feature
+    # @param user_id [String] user id
+    # @return [Success, RequestError]
+    def beta_feature(action, beta_feature_id, user_id)
+      validate_number beta_feature_id
+      validate_number user_id
+
+      if action != :delete
+        params = { 'beta_feature.id' => beta_feature_id, 'beta_feature.enabled' => action == :enable }
+
+        patch("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}", params)
+      else
+        delete("#{without_repo}/user/#{user_id}/beta_feature/#{beta_feature_id}")
+      end
+    end
+
+    # A list of beta features. Beta features are new Travis CI features in beta mode. They can be toggled on or off via the API or on this page on our site: https://travis-ci.com/features
+    #
+    # ## Attributes
+    #
+    #     Name           Type            Description
+    #     beta_features  [Beta feature]  List of beta_features.
+    #
+    # ## Actions
+    #
+    # **Find**
+    #
+    # This will return a list of beta features available to a user.
+    #
+    # GET <code>/user/{user.id}/beta_features</code>
+    #
+    #     Template Variable  Type     Description
+    #     user.id            Integer  Value  uniquely identifying the user.
+    #     Query Parameter  Type      Description
+    #     include          [String]  List of attributes to eager load.
+    #
+    #     Example: GET /user/119240/beta_features
+    #
+    # @note requests require an authorization token set in the headers. See: {authorization=}
+    #
+    # @param user_id [String, Integer] user id
+    # @return [Success, RequestError]
+    def beta_features(user_id)
+      validate_number user_id
+
+      get("#{without_repo}/user/#{user_id}/beta_features")
+    end
+
     # The branch of a GitHub repository. Useful for obtaining information about the last build on a given branch.
     #
     # **If querying using the repository slug, it must be formatted using {http://www.w3schools.com/tags/ref_urlencode.asp standard URL encoding}, including any special characters.**
@@ -281,6 +370,47 @@ module Trav3
       get("#{with_repo}/branches#{opts}")
     end
 
+    # A list of broadcasts for the current user.
+    #
+    # ## Attributes
+    #
+    #     Name        Type         Description
+    #     broadcasts  [Broadcast]  List of broadcasts.
+    #
+    # **Collection Items**
+    #
+    # Each entry in the broadcasts array has the following attributes:
+    #
+    #     Name        Type     Description
+    #     id          Integer  Value uniquely identifying the broadcast.
+    #     message     String   Message to display to the user.
+    #     created_at  String   When the broadcast was created.
+    #     category    String   Broadcast category (used for icon and color).
+    #     active      Boolean  Whether or not the brodacast should still be displayed.
+    #     recipient   Object   Either a user, organization or repository, or null for global.
+    #
+    # ## Actions
+    #
+    # **For Current User**
+    #
+    # This will return a list of broadcasts for the current user.
+    #
+    # GET <code>/broadcasts</code>
+    #
+    #     Query Parameter   Type       Description
+    #     active            [Boolean]  Alias for broadcast.active.
+    #     broadcast.active  [Boolean]  Filters broadcasts by whether or not the brodacast should still be displayed.
+    #     include           [String]   List of attributes to eager load.
+    #
+    #     Example: GET /broadcasts
+    #
+    # @note requests require an authorization token set in the headers. See: {authorization=}
+    #
+    # @return [Success, RequestError]
+    def broadcasts
+      get("#{without_repo}/broadcasts")
+    end
+
     # An individual build.
     #
     # ## Attributes
@@ -1086,12 +1216,7 @@ module Trav3
     # @param create [Hash] Optional argument.  A hash of the `name`, `value`, and `public` visibleness for a env var to create
     # @return [Success, RequestError]
     def env_vars(create = nil)
-      if create
-        validate_env_var create
-
-        return create("#{with_repo}/env_vars", env_var_keys(create))
-      end
-
+      create and return create("#{with_repo}/env_vars", env_var_keys(create))
       get("#{with_repo}/env_vars")
     end
 
@@ -2730,7 +2855,7 @@ module Trav3
     end
 
     def get_path_with_opts(url)
-      url, opt = url.match(/(.+)\?(.*)/)&.captures || url
+      url, opt = url.match(/^(.+)\?(.*)$/)&.captures || url
       opts.immutable do |o|
         o.send(:update, opt)
         get_path("#{url}#{opts}")
@@ -2745,7 +2870,8 @@ module Trav3
     end
 
     def inject_property_name(name, hash)
-      return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/\A#{name}\.\w+\z/)
+      raise TypeError, "Hash expected, #{input.class} given" unless hash.is_a? Hash
+      return hash.map { |k, v| ["#{name}.#{k}", v] }.to_h unless hash.keys.first.match?(/^#{name}\.\w+$/)
 
       hash
     end
@@ -2774,20 +2900,6 @@ module Trav3
       raise InvalidAPIEndpoint unless /^https:\/\/api\.travis-ci\.(?:org|com)$/.match? input
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
-    def validate_env_var(input)
-      raise TypeError, "Hash expected, #{input.class} given" unless input.is_a? Hash
-      raise EnvVarError unless input.all? do |k, v|
-        k.match?(/name|value|public/) &&
-        case k.to_s
-        when /name/ then v.is_a? String
-        when /value/ then v.is_a? String
-        when /public/ then [true, false].include? v
-        end
-      end
-    end
-    # rubocop:enable Metrics/CyclomaticComplexity
-
     def validate_number(input)
       raise TypeError, "Integer expected, #{input.class} given" unless number? input
     end

data/lib/trav3/errors.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'error/env_var_error'
 require_relative 'error/invalid_api_endpoint'
 require_relative 'error/invalid_repository'
 require_relative 'error/unimplemented'

data/lib/trav3/headers.rb

@@ -5,12 +5,15 @@ require 'forwardable'
 module Trav3
   class Headers
     extend Forwardable
-    def_delegators :@heads, :each_pair
+    def_delegators :@heads, :each_pair, :fetch
 
     def initialize(args = {})
       build(args)
     end
 
+    # Add or update the request headers
+    #
+    # @return [Headers] self
     def build(args = {})
       @heads ||= {}
 
@@ -21,10 +24,18 @@ module Trav3
       self
     end
 
+    # Remove key/value from headers via key
+    #
+    # @param key [Symbol, String] key to look up
+    # @return [String, Symbol, nil] returns value if key found, `nil` otherwise.
     def remove(key)
       @heads.delete(key)
     end
 
+    # Add the values of one `Headers` into another
+    #
+    # @param other [Headers] instance of `Headers`
+    # @return [Headers]
     def +(other)
       raise TypeError, "Headers type expected, #{other.class} given" unless other.is_a? Headers
 
@@ -33,6 +44,7 @@ module Trav3
       self
     end
 
+    # @return [Hash] hash of the `Headers`
     def to_h
       @heads
     end

data/lib/trav3/options.rb

@@ -6,6 +6,9 @@ module Trav3
       build(args)
     end
 
+    # url safe rendering of options for the url
+    #
+    # @return [String] url options
     def opts
       if @opts.empty?
         ''
@@ -14,6 +17,9 @@ module Trav3
       end
     end
 
+    # Add or update url options
+    #
+    # @return [Options] self
     def build(args = {})
       @opts ||= []
 
@@ -25,6 +31,10 @@ module Trav3
       self
     end
 
+    # Fetch the `key=value`
+    #
+    # @param [Symbol, String] key of the key/value pair to fetch
+    # @return [String]
     def fetch(key)
       @opts.each do |item|
         return item if key.to_s == split.call(item).first
@@ -35,12 +45,18 @@ module Trav3
       yield
     end
 
+    # Fetch and remove `key=value`.  Modifies `Options`.
+    #
+    # @param [Symbol, String] key of the key/value pair to fetch
+    # @return [String]
     def fetch!(key, &block)
       result = fetch(key, &block)
       remove(key)
       result
     end
 
+    # Execute a block of code and restore original `Options` state afterwards
+    # @yield [Options]
     def immutable
       old = @opts
       result = yield self
@@ -48,6 +64,10 @@ module Trav3
       result
     end
 
+    # Remove key/value from options via key
+    #
+    # @param key [Symbol, String] key to look up
+    # @return [String, nil] returns a `String` if key found, `nil` otherwise.
     def remove(key)
       return_value = nil
 
@@ -60,12 +80,19 @@ module Trav3
       return_value
     end
 
+    # this purges all options
+    #
+    # @return [Options] self
     def reset!
       @opts = []
 
       self
     end
 
+    # Add the values of one `Options` into another
+    #
+    # @param other [Options] instance of `Options`
+    # @return [Options]
     def +(other)
       raise TypeError, "Options type expected, #{other.class} given" unless other.is_a? Options
 
@@ -74,10 +101,12 @@ module Trav3
       self
     end
 
+    # (see #opts)
     def to_s
       opts
     end
 
+    # @return [Hash] hash of the `Options`
     def to_h
       @opts.map(&split).to_h
     end

data/lib/trav3/response/response_collection.rb

@@ -48,6 +48,13 @@ module Trav3
       self[0]
     end
 
+    # Follows `@href` link within item.
+    # If `#hash?` returns `true` then `#follow` takes no parameters.
+    # If `#hash?` returns `false` then `#follow` takes an index parameter
+    #   for which item in the Array you wish to follow.
+    #
+    # @param idx [Integer] (optional parameter) index of array of item to follow `@href` url from
+    # @return [Success, RequestError]
     def follow(idx = nil)
       if href? && !idx
         url = collection.fetch('@href')

data/lib/trav3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trav3
-  VERSION = '0.3.4'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trav3
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2019-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,6 @@ files:
 - bin/console
 - bin/setup
 - lib/trav3.rb
-- lib/trav3/error/env_var_error.rb
 - lib/trav3/error/invalid_api_endpoint.rb
 - lib/trav3/error/invalid_repository.rb
 - lib/trav3/error/unimplemented.rb

data/lib/trav3/error/env_var_error.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Trav3
-  class EnvVarError < StandardError
-    def message
-      "You must provide the keys `name`, `value`, and `public`\
-      where name and value are given String values and public is a Boolean."
-    end
-  end
-end