diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..973c57c --- /dev/null +++ b/CHANGELOG.md @@ -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 diff --git a/Gemfile.lock b/Gemfile.lock index 068ec24..726af10 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - obvious (0.1.0) + obvious (0.2.0) GEM remote: https://rubygems.org/ diff --git a/README.md b/README.md index 7457c03..919f4de 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/lib/obvious.rb b/lib/obvious.rb index d9de4ab..5465f00 100644 --- a/lib/obvious.rb +++ b/lib/obvious.rb @@ -2,4 +2,3 @@ require 'obvious/contract' require 'obvious/entity' require 'obvious/obj' -require_relative 'generators/application_generator' diff --git a/lib/obvious/version.rb b/lib/obvious/version.rb index 4c77fa6..2ff2be1 100644 --- a/lib/obvious/version.rb +++ b/lib/obvious/version.rb @@ -1,3 +1,3 @@ module Obvious - VERSION = "0.1.0" + VERSION = "0.2.0" end diff --git a/obvious.gemspec b/obvious.gemspec index 2f63791..b3a9105 100644 --- a/obvious.gemspec +++ b/obvious.gemspec @@ -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 = ["brianknapp@gmail.com"] + gem.authors = ["Brian Knapp", "Shawn Baden"] + gem.email = ["brianknapp@gmail.com", "shawnbaden@hotmail.com"] 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)/})