Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump v020 #58

Merged
merged 6 commits into from
Feb 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Changelog

All notable changes to this project will be documented in this file.

## [0.2.0]

### Added

### Changed

- Updated README to be current
- Removed generators from Obvious
- Refactored Obvious::Obj#define to be simpler
- Replaced RSPec with Minitest for testing

### Fixed

- Fixed namespace issues with Contract errors
- Updated project URL on Rubygems listing
2 changes: 1 addition & 1 deletion Gemfile.lock
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PATH
remote: .
specs:
obvious (0.1.0)
obvious (0.2.0)

GEM
remote: https://rubygems.org/
Expand Down
27 changes: 4 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Obvious

Obvious is an architecture framework. The goal is to provide architectural structure for a highly testable system that is
obvious to understand and where both the front end UI and back end infrastructure are treated as implementation details
independent of the app logic itself.
Obvious is an architecture framework. The goal is to provide architectural
structure for a highly testable system that is obvious to understand and where
both the front end UI and back end infrastructure are treated as implementation
details independent of the app logic itself.

## Installation

Expand All @@ -13,23 +14,3 @@ Add this line to your application's Gemfile:
And then execute:

$ bundle

Or install it yourself as:

$ gem install obvious

## Usage

Obvious is designed to be used in two ways - as a gem you require in your Obvious projects and also as an Obvious project
generation tool.

The project generation tool is run by executing...

$ obvious generate

in a directory containing a decriptors directory. You can read more about descriptors on the Obvious page or see an example
in the Obvious Status example app: https://github.com/RetroMocha/obvious_status.

Currently the footprint of the Obvious library is quite small. The most important things defined so far are the Contract class
and the Hash.has_shape? method. The rest of what makes an Obvious app interesting is the structure itself, not the libraries Obvious
provides.
1 change: 0 additions & 1 deletion lib/obvious.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@
require 'obvious/contract'
require 'obvious/entity'
require 'obvious/obj'
require_relative 'generators/application_generator'
2 changes: 1 addition & 1 deletion lib/obvious/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Obvious
VERSION = "0.1.0"
VERSION = "0.2.0"
end
8 changes: 4 additions & 4 deletions obvious.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ require 'obvious/version'
Gem::Specification.new do |gem|
gem.name = "obvious"
gem.version = Obvious::VERSION
gem.authors = ["Brian Knapp"]
gem.email = ["[email protected]"]
gem.authors = ["Brian Knapp", "Shawn Baden"]
gem.email = ["[email protected]", "[email protected]"]
gem.description = "A set of tools to build apps using the Obvious Architecture"
gem.summary = "Clean Architecture framework"
gem.homepage = "http://obvious.retromocha.com/"

gem.homepage = "https://github.com/RetroMocha/obvious"
gem.license = "MIT"
gem.files = `git ls-files`.split($/)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
Expand Down