civil 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d2daf7eb5fdf64d4cab227079bf992c8008c5be
+  data.tar.gz: 0a6f4fa9e751ca1ed84fb43e0c2c0ffd31f2fd0b
+SHA512:
+  metadata.gz: 9f1be6f7162cc833f4af0997bceac0817997fe9f86497341f16d008f234a6e69c87039e96dbe4c965815ee08f200b66225eaa3ecaadb5387236252fda8f02d99
+  data.tar.gz: b03a199806ecb0824cb2c191d2ede1e50778a01f16a554911aa0fc592558b61f4ac89d786c419c4ad07dec1d0410d0134637f1437de4eb21b6c938e17ad5ce03

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/tmp/
+*.swp

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+civil

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## 0.1.0 - 2016-11-30
+### Added
+- Initial commit, imported files that I had originally written for [StandardService](https://github.com/TheTroveApp/standard-service)
+- Civil::Result and Civil::Service classes
+- Specs for Civil::Result and Civil::Service
+- Various bits of tooling for RVM, Rake, RSpec, etc.
+- Documentation and examples in README.md
+- This changelog :-)
+
+[Unreleased]: https://github.com/earksiinni/civil/compare/v0.1.0...HEAD

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in civil.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ersin Akinci
+
+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,126 @@
+# Civil
+
+An opinionated Ruby framework for standardizing services, their inputs and their outputs. [![Build Status](https://travis-ci.org/earksiinni/civil.svg?branch=master)](https://travis-ci.org/earksiinni/civil)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'civil'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install civil
+
+## Getting started
+
+Write your service:
+
+```ruby
+class MyService
+  include Civil::Service
+
+  # Use attribute readers for input parameters
+  attr_reader :foo
+  attr_accessor :buffer
+
+  service do
+    do_something
+    do_something_else
+  end
+
+  def do_something
+    self.buffer = foo + 3
+  end
+
+  def do_something_else
+    self.buffer = buffer * 2
+  end
+end
+```
+
+Invoke your service:
+
+```ruby
+# Pass input parameters in hash
+result = MyService.call foo: 10
+
+result.data       # 26; result.data == the last return value from inside the service block
+result.conditions # {}; add conditions to indicate non-happy path results (see below)
+result.meta       # {}
+result.ideal?     # true; because there are no conditions
+result.deviant?   # false
+```
+
+## Usage
+
+### Conditions
+
+Civil distinguishes between "errors" and "conditions":
+
+- An error results from an unexpected behavior that has nothing to do with your business logic. For example, a user attempting to access an unauthorized resource.
+- A condition results from an expected behavior that deviates from the happy path in your business logic. For example, a user attempting to upload an avatar image that's too big.
+
+Civil currently doesn't handle errors. To add a condition, use `#add_condition`:
+
+```ruby
+class SaveAvatarImage
+  ...
+
+  def check_image_size
+    add_condition :image_too_big, "The uploaded image must be < 1 MB in size" if image_size_too_big?
+  end
+end
+```
+
+Your condition will be available in your result:
+
+```ruby
+result = SaveAvatarImage.call image: image
+
+result.conditions # { image_too_big: "The uploaded image must be < 1 MB in size" }
+result.ideal?     # false
+result.deviant?   # true
+```
+
+Results from service calls that have no conditions are said to be "ideal" whereas those with conditions are said to be "deviant." Two helper methods, `ideal?` and `deviant?`, provide shortcuts for checking for the presence of conditions. Note that we intentionally avoid the commonly used terms "success" and "failure" as these relate to errors, not conditions.
+
+### Metadata
+
+Metadata can be returned with any ideal or deviant result by using `add_meta`:
+
+```ruby
+class MetadataExample
+  ...
+
+  def process_doodad
+    add_meta :length, 12.5
+  end
+end
+
+result = MetadataExample.call doodad: doodad
+
+result.meta # { length: 12.5 }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/earksiinni/civil. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "civil"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/civil.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'civil/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "civil"
+  spec.version       = Civil::VERSION
+  spec.authors       = ["Ersin Akinci"]
+  spec.email         = ["ersin.akinci@gmail.com"]
+
+  spec.summary       = %q{Standardize your services, their inputs and their outputs}
+  spec.description   = %q{Services help keep your business logic clean, but what helps keep your services clean? Civil provides a framework for writing services that all have a standardized structure, inputs and outputs.}
+  spec.homepage      = "https://github.com/earksiinni/civil"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/lib/civil/result.rb

@@ -0,0 +1,27 @@
+module Civil
+  class Result
+    attr_reader :data, :conditions, :meta
+
+    def initialize(data, conditions = {}, meta = {})
+      @data = data
+      @conditions = conditions
+      @meta = meta
+    end
+
+    def ideal?
+      conditions.empty?
+    end
+
+    def deviant?
+      !ideal?
+    end
+
+    def to_s
+      data.to_s
+    end
+
+    def to_json
+      data.to_json
+    end
+  end
+end

data/lib/civil/service.rb

@@ -0,0 +1,58 @@
+module Civil
+  module Service
+    def self.included(klass)
+      class << klass
+        # Civil::Service.service
+        # Wrapper method, used within service class
+        #
+        # service do
+        #   execute_step_1
+        #   execute_step_2
+        #   ...
+        # end
+        def service(&block)
+          define_method '_run', &block
+        end
+
+        # Civil::Service.call
+        # Initiate service execution and return standardized result
+        #
+        # result = MyService.call(foo: 1, bar: 'a')
+        # 
+        # if result.ideal?
+        #   ...
+        # else
+        #   ...
+        # end
+        def call(params = {})
+          service = new(params)
+          data = service._run
+
+          Civil::Result.new(data, service._conditions, service._meta)
+        end
+      end
+    end
+
+    def initialize(params = {})
+      params.to_h.each do |(name, value)|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def add_condition(type, desc = "")
+      _conditions[type.to_sym] = desc.to_s
+    end
+
+    def add_meta(type, desc = "")
+      _meta[type.to_sym] = desc.to_s
+    end
+
+    def _conditions
+      @_conditions ||= {}
+    end
+
+    def _meta
+      @_meta ||= {}
+    end
+  end
+end

data/lib/civil/version.rb

@@ -0,0 +1,3 @@
+module Civil
+  VERSION = "0.1.0"
+end

data/lib/civil.rb

@@ -0,0 +1,3 @@
+require "civil/version"
+require "civil/service"
+require "civil/result"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: civil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ersin Akinci
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Services help keep your business logic clean, but what helps keep your
+  services clean? Civil provides a framework for writing services that all have a
+  standardized structure, inputs and outputs.
+email:
+- ersin.akinci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- civil.gemspec
+- lib/civil.rb
+- lib/civil/result.rb
+- lib/civil/service.rb
+- lib/civil/version.rb
+homepage: https://github.com/earksiinni/civil
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Standardize your services, their inputs and their outputs
+test_files: []