2017-09-01 18:41:09 +00:00
|
|
|
//
|
|
|
|
// imag - the personal information management suite for the commandline
|
2018-02-07 01:48:53 +00:00
|
|
|
// Copyright (C) 2015-2018 Matthias Beyer <mail@beyermatthias.de> and contributors
|
2017-09-01 18:41:09 +00:00
|
|
|
//
|
|
|
|
// This library is free software; you can redistribute it and/or
|
|
|
|
// modify it under the terms of the GNU Lesser General Public
|
|
|
|
// License as published by the Free Software Foundation; version
|
|
|
|
// 2.1 of the License.
|
|
|
|
//
|
|
|
|
// This library is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
// Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public
|
|
|
|
// License along with this library; if not, write to the Free Software
|
|
|
|
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
//
|
|
|
|
|
|
|
|
use error::Result;
|
|
|
|
use habit::builder::HabitBuilder;
|
|
|
|
use iter::HabitTemplateStoreIdIterator;
|
2017-11-24 17:55:12 +00:00
|
|
|
use iter::HabitInstanceStoreIdIterator;
|
2017-09-01 18:41:09 +00:00
|
|
|
|
|
|
|
use libimagstore::store::Store;
|
|
|
|
|
|
|
|
/// Extension trait for libimagstore::store::Store which is basically our Habit-Store
|
|
|
|
pub trait HabitStore {
|
|
|
|
|
|
|
|
/// Create a new habit
|
|
|
|
fn create_habit(&self) -> HabitBuilder {
|
|
|
|
HabitBuilder::default()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Get an iterator over all habits
|
|
|
|
fn all_habit_templates(&self) -> Result<HabitTemplateStoreIdIterator>;
|
|
|
|
|
2017-11-24 17:55:12 +00:00
|
|
|
/// Get instances
|
|
|
|
fn all_habit_instances(&self) -> Result<HabitInstanceStoreIdIterator>;
|
|
|
|
|
|
|
|
// /// Get instances of a certain date
|
|
|
|
// fn all_habit_instances_on(&self, date: &NaiveDate) -> Result<HabitInstanceStoreIdIterator>;
|
|
|
|
|
|
|
|
// /// Get instances between two dates
|
|
|
|
// fn all_habit_instances_between(&self, start: &NaiveDate, end: &NaiveDate) -> Result<HabitInstanceStoreIdIterator>;
|
2017-09-01 18:41:09 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
impl HabitStore for Store {
|
|
|
|
/// Get an iterator over all habits
|
|
|
|
fn all_habit_templates(&self) -> Result<HabitTemplateStoreIdIterator> {
|
Optimize the Store::entries() interface
The previous iterator was implemented to simply fetch _all_ pathes from
the filesystem, no matter what.
With this implementation, this changes. The iterator now has
functionality to optimize the iteration, if only a subdirectory of the
store is required, for example `$STORE/foo`.
This is done via functionality where the underlying iterator gets
altered.
First of all, the interface was changed to return a `Entries` object,
which itself only covers the libimagstore-internal `PathIterator` type.
This type was changed so that the backend implementation provides an
"PathIterBuilder`, which builds the actual iterator object for the
`PathIterator` type.
The intermediate `StoreIdConstructingIterator` was merged into
`PathIterator` for simplicity.
The `Entries` type got functionality similar to the
`StoreIdIteratorWithStore` type for easier transition to the new API.
This should probably be removed at a later point, though.
As the `walkdir::WalkDir` type is not as nice as it could be, iterators
for two collections in the store could be built like this (untested):
store
.entries()?
.in_collection("foo")
.chain(store.entries()?.in_collection("bar"))
Functionality to exclude subdirectories is not possible with the current
`walkdir::WalkDir` implementation and has to be done during iteration,
with filtering (as usual).
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-06-06 22:29:52 +00:00
|
|
|
Ok(HabitTemplateStoreIdIterator::from(self.entries()?.without_store()))
|
2017-09-01 18:41:09 +00:00
|
|
|
}
|
2017-11-24 17:55:12 +00:00
|
|
|
|
|
|
|
fn all_habit_instances(&self) -> Result<HabitInstanceStoreIdIterator> {
|
Optimize the Store::entries() interface
The previous iterator was implemented to simply fetch _all_ pathes from
the filesystem, no matter what.
With this implementation, this changes. The iterator now has
functionality to optimize the iteration, if only a subdirectory of the
store is required, for example `$STORE/foo`.
This is done via functionality where the underlying iterator gets
altered.
First of all, the interface was changed to return a `Entries` object,
which itself only covers the libimagstore-internal `PathIterator` type.
This type was changed so that the backend implementation provides an
"PathIterBuilder`, which builds the actual iterator object for the
`PathIterator` type.
The intermediate `StoreIdConstructingIterator` was merged into
`PathIterator` for simplicity.
The `Entries` type got functionality similar to the
`StoreIdIteratorWithStore` type for easier transition to the new API.
This should probably be removed at a later point, though.
As the `walkdir::WalkDir` type is not as nice as it could be, iterators
for two collections in the store could be built like this (untested):
store
.entries()?
.in_collection("foo")
.chain(store.entries()?.in_collection("bar"))
Functionality to exclude subdirectories is not possible with the current
`walkdir::WalkDir` implementation and has to be done during iteration,
with filtering (as usual).
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2018-06-06 22:29:52 +00:00
|
|
|
Ok(HabitInstanceStoreIdIterator::from(self.entries()?.without_store()))
|
2017-11-24 17:55:12 +00:00
|
|
|
}
|
2017-09-01 18:41:09 +00:00
|
|
|
}
|
2017-11-24 17:55:12 +00:00
|
|
|
|